PagesRange
(Automatic page editing by robot) |
(→See Also) |
||
(5 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
{{#customTitle:PagesRange}} | {{#customTitle:PagesRange}} | ||
{{#parentPage:PXV:Params_CommonStructures|PagesRange|structure}} | {{#parentPage:PXV:Params_CommonStructures|PagesRange|structure}} | ||
− | + | ||
{{ToReview}} | {{ToReview}} | ||
Line 14: | Line 14: | ||
| class="op_param_name" | Type | | class="op_param_name" | Type | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the type of the data that will be used in the Pages Range. |
The list of possible values are shown in [[PXV:Params_NamedValues_RangeTypes|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_RangeTypes|the table]]. | ||
Line 21: | Line 21: | ||
| class="op_param_name" | Filter | | class="op_param_name" | Filter | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies | + | | Specifies the filter that will be applied to the data from the Pages Range type. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
− | | class="op_enum_value" | '''1''' (All) || | + | | class="op_enum_value" | '''1''' (All) || All pages will be used. |
|- | |- | ||
− | | class="op_enum_value" | '''4''' (Odd) || | + | | class="op_enum_value" | '''4''' (Odd) || Only odd pages will be used. |
|- | |- | ||
− | | class="op_enum_value" | '''5''' (Even) || | + | | class="op_enum_value" | '''5''' (Even) || only even pages will be used. |
|} | |} | ||
Default value: <tt>'''1''' (All)</tt> | Default value: <tt>'''1''' (All)</tt> | ||
Line 35: | Line 35: | ||
| class="op_param_name" | Text | | class="op_param_name" | Text | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
− | | Specifies. | + | | Specifies the text that will be used as range. This property is used with <tt>'''6''' (Exact)</tt> type. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Reversed | | class="op_param_name" | Reversed | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
− | | Specifies | + | | Specifies whether the range should be read from it's end to the beginning or not. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
Line 46: | Line 46: | ||
| style="text-align:center" | Array | | style="text-align:center" | Array | ||
| Array of <tt>'''Integer'''</tt> | | Array of <tt>'''Integer'''</tt> | ||
− | Specifies. | + | Specifies the array of values that will be used as a Pages Range. This property is used with <tt>'''7''' (Array)</tt> type. |
|- | |- | ||
| class="op_param_name" | Custom | | class="op_param_name" | Custom | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies. | + | | Specifies the custom page. This property is used with <tt>'''10''' (CustomRect)</tt> type. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[PXV:cs_RectF|CustomRect]] | | class="op_param_name" | [[PXV:cs_RectF|CustomRect]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies. | + | | Specifies the custom rectangle. This property is used with <tt>'''10''' (CustomRect)</tt> type. |
|- | |- | ||
| class="op_param_name" | Current | | class="op_param_name" | Current | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
− | | Specifies. | + | | Specifies the current page. This property is used with <tt>'''8''' (Current)</tt> type. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[PXV:cs_RectF|CurrentRect]] | | class="op_param_name" | [[PXV:cs_RectF|CurrentRect]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
− | | Specifies. | + | | Specifies the current rectangle. This property is used with <tt>'''9''' (CurrentRect)</tt> type. |
|} | |} | ||
== See Also == | == See Also == | ||
− | [[PXV:op_annots_delete]], [[PXV:op_annots_flatten]], [[PXV:op_document_addBackground]], [[PXV:op_document_addBatesNumbering]], [[PXV:op_document_addGuides]], [[PXV:op_document_addHeaderAndFooter]], [[PXV:op_document_addWatermarks]], [[PXV:op_document_changePagesProps]], [[PXV:op_document_cropPages]], [[PXV:op_document_deletePages]], [[PXV:op_document_exportToImages]], [[PXV:op_document_extractPages]], [[PXV:op_document_insertPages]], [[PXV:op_document_movePages]], [[PXV:op_document_printPages]], [[PXV:op_document_replacePages]], [[PXV:op_document_resizePages]], [[PXV:op_document_rotatePages]], [[PXV:op_document_summarizeAnnots]], [[PXV:op_document_updateBackground | + | [[PXV:op_annots_delete]], [[PXV:op_annots_flatten]], [[PXV:op_document_addBackground]], [[PXV:op_document_addBatesNumbering]], [[PXV:op_document_addGuides]], [[PXV:op_document_addHeaderAndFooter]], [[PXV:op_document_addWatermarks]], [[PXV:op_document_changePagesProps]], [[PXV:op_document_cropPages]], [[PXV:op_document_deletePages]], [[PXV:op_document_exportToImages]], [[PXV:op_document_extractPages]], [[PXV:op_document_insertPages]], [[PXV:op_document_movePages]], [[PXV:op_document_printPages]], [[PXV:op_document_replacePages]], [[PXV:op_document_resizePages]], [[PXV:op_document_rotatePages]], [[PXV:op_document_summarizeAnnots]], [[PXV:op_document_updateBackground]] |
Latest revision as of 06:59, 14 April 2016
Options Table
Name | Type | Value | ||||||
---|---|---|---|---|---|---|---|---|
Type | Integer | Specifies the type of the data that will be used in the Pages Range.
The list of possible values are shown in the table. Default value: -1 (Auto) | ||||||
Filter | Integer | Specifies the filter that will be applied to the data from the Pages Range type.
Possible values are:
Default value: 1 (All) | ||||||
Text | String | Specifies the text that will be used as range. This property is used with 6 (Exact) type.
Default value: Empty String | ||||||
Reversed | Boolean | Specifies whether the range should be read from it's end to the beginning or not.
Default value: false | ||||||
Array | Array | Array of Integer
Specifies the array of values that will be used as a Pages Range. This property is used with 7 (Array) type. | ||||||
Custom | Integer | Specifies the custom page. This property is used with 10 (CustomRect) type.
Default value: -1 | ||||||
CustomRect | Dictionary | Specifies the custom rectangle. This property is used with 10 (CustomRect) type. | ||||||
Current | Integer | Specifies the current page. This property is used with 8 (Current) type.
Default value: 0 | ||||||
CurrentRect | Dictionary | Specifies the current rectangle. This property is used with 9 (CurrentRect) type. |
See Also
op.annots.delete, op.annots.flatten, op.document.addBackground, op.document.addBatesNumbering, op.document.addGuides, op.document.addHeaderAndFooter, op.document.addWatermarks, op.document.changePagesProps, op.document.cropPages, op.document.deletePages, op.document.exportToImages, op.document.extractPages, op.document.insertPages, op.document.movePages, op.document.printPages, op.document.replacePages, op.document.resizePages, op.document.rotatePages, op.document.summarizeAnnots, op.document.updateBackground