Options
From PDF XChange PDF SDK
| Line 25: | Line 25: | ||
| class="op_param_name" | Color | | class="op_param_name" | Color | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies the color in string presentation | + | | Specifies the color in string presentation that will be used if color ''Type'' is specified. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | PageNumber | | class="op_param_name" | PageNumber | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies the number of page in the file | + | | Specifies the number of page in the file that is used as background. |
Default value: <tt>'''1'''</tt> | Default value: <tt>'''1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | AbsoluteScale | | class="op_param_name" | AbsoluteScale | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies the absolute scale value in percent | + | | Specifies the absolute scale value in percent that will be used if the ''UseRelativeScale'' flag is false. |
Default value: <tt>'''1.0'''</tt> | Default value: <tt>'''1.0'''</tt> | ||
|- | |- | ||
| Line 99: | Line 99: | ||
| class="op_param_name" | PresetID | | class="op_param_name" | PresetID | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies the preset id | + | | Specifies the preset id that 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 the pages range | + | | Specifies the pages range which the background should be applied to. |
|} | |} | ||
Revision as of 06:08, 27 May 2015
Options Table
| Name | Type | Value | ||||
|---|---|---|---|---|---|---|
| Type | Integer | Specifies the type of data used for background generation.
Possible values are:
Default value: 0 (Color) | ||||
| Color | String | Specifies the color in string presentation that will be used if color Type is specified.
Default value: Empty String | ||||
| PageNumber | Integer | Specifies the number of page in the file that is used as background.
Default value: 1 | ||||
| AbsoluteScale | Double | Specifies the absolute scale value in percent that will be used if the UseRelativeScale flag is false.
Default value: 1.0 | ||||
| FileName | String | Specifies the background image file path.
Default value: Empty String | ||||
| Rotation | Double | Specifies the rotation of the background in degrees.
Default value: 0.0 | ||||
| Opacity | Double | Specifies the opacity of the background in percent.
Default value: 1.0 | ||||
| UseRelativeScale | Boolean | Specifies whether the relative scale should be used.
Default value: true | ||||
| RelativeScale | Double | Specifies the relative scale value in percent.
Default value: 1.0 | ||||
| HOffset | Double | Specifies the horizontal offset of the background in points.
Default value: 0.0 | ||||
| VOffset | Double | Specifies the vertical offset of the background in points.
Default value: 0.0 | ||||
| VOffsetFrom | Integer | Specifies where the vertical offset should be made from.
The list of possible values are shown in the table. Default value: 1 (Center) | ||||
| HOffsetFrom | Integer | Specifies where the horizontal offset should be made from.
The list of possible values are shown in the table. Default value: 1 (Center) | ||||
| VisibleOnView | Boolean | Specifies whether the background should be visible on view.
Default value: true | ||||
| VisibleOnPrint | Boolean | Specifies whether the background should be visible on print.
Default value: true | ||||
| PresetID | String | Specifies the preset id that should be used when loading the settings of the dialog.
Default value: Empty String | ||||
| PagesRange | Dictionary | Specifies the pages range which the background should be applied to. |
