Options
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| Line 14: | Line 14: | ||
| class="op_param_name" | [[PXV:cs_FontParams|Font]] | | class="op_param_name" | [[PXV:cs_FontParams|Font]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the font which will be used when generating Bates Numbering. |
|- | |- | ||
| class="op_param_name" | LeftHeaderText | | class="op_param_name" | LeftHeaderText | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the left header text. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | CenterHeaderText | | class="op_param_name" | CenterHeaderText | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the central header text. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | RightHeaderText | | class="op_param_name" | RightHeaderText | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the right header text. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | LeftFooterText | | class="op_param_name" | LeftFooterText | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the left footer text. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | CenterFooterText | | class="op_param_name" | CenterFooterText | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the central footer text. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | RightFooterText | | class="op_param_name" | RightFooterText | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the right footer text. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[PXV:cs_RectF|Margins]] | | class="op_param_name" | [[PXV:cs_RectF|Margins]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the margins used for the Bates Numbering positioning. |
The following default values of base [[PXV:cs_RectF|structure]] are overridden : | The following default values of base [[PXV:cs_RectF|structure]] are overridden : | ||
:<code>top</code>: <tt>'''36.0'''</tt>, | :<code>top</code>: <tt>'''36.0'''</tt>, | ||
| Line 57: | Line 57: | ||
| class="op_param_name" | DateFormat | | class="op_param_name" | DateFormat | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the date format that will be used in the dialog. |
Default value: <tt>'''m/d'''</tt> | Default value: <tt>'''m/d'''</tt> | ||
|- | |- | ||
| class="op_param_name" | PageNumberFormat | | class="op_param_name" | PageNumberFormat | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the page numbering format that will be used in the dialog. |
Default value: <tt>'''1'''</tt> | Default value: <tt>'''1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | StartPageNumber | | class="op_param_name" | StartPageNumber | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the starting page number for the page numeration when the formats from the ''PageNumberFormat'' are used in the Bates Numbering generation. |
Default value: <tt>'''1'''</tt> | Default value: <tt>'''1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | PresetID | | class="op_param_name" | PresetID | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the preset id which should be used when loading the settings of the dialog. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[PXV:cs_PagesRange|PagesRange]] | | class="op_param_name" | [[PXV:cs_PagesRange|PagesRange]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the pages range to which the Bates Numbering should be applied. |
|- | |- | ||
| class="op_param_name" | BatesNumberingID | | class="op_param_name" | BatesNumberingID | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies. | + | | Specifies the ID of the pagemark group which should be modified. If the ID is empty the Bates Numbering will be added as a new group, otherwise the group with the given ID will be modified. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|} | |} | ||
Revision as of 23:53, 26 May 2015
Options Table
| Name | Type | Value |
|---|---|---|
| Font | Dictionary | Specifies the font which will be used when generating Bates Numbering. |
| LeftHeaderText | String | Specifies the left header text.
Default value: Empty String |
| CenterHeaderText | String | Specifies the central header text.
Default value: Empty String |
| RightHeaderText | String | Specifies the right header text.
Default value: Empty String |
| LeftFooterText | String | Specifies the left footer text.
Default value: Empty String |
| CenterFooterText | String | Specifies the central footer text.
Default value: Empty String |
| RightFooterText | String | Specifies the right footer text.
Default value: Empty String |
| Margins | Dictionary | Specifies the margins used for the Bates Numbering positioning.
The following default values of base structure are overridden :
|
| DateFormat | String | Specifies the date format that will be used in the dialog.
Default value: m/d |
| PageNumberFormat | String | Specifies the page numbering format that will be used in the dialog.
Default value: 1 |
| StartPageNumber | Integer | Specifies the starting page number for the page numeration when the formats from the PageNumberFormat are used in the Bates Numbering generation.
Default value: 1 |
| PresetID | String | Specifies the preset id which should be used when loading the settings of the dialog.
Default value: Empty String |
| PagesRange | Dictionary | Specifies the pages range to which the Bates Numbering should be applied. |
| BatesNumberingID | String | Specifies the ID of the pagemark group which should be modified. If the ID is empty the Bates Numbering will be added as a new group, otherwise the group with the given ID will be modified.
Default value: Empty String |
