Options
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| Line 2: | Line 2: | ||
{{#customTitle:Options}} | {{#customTitle:Options}} | ||
{{#parentPage:PXV:op_document_addBackground|Options|property}} | {{#parentPage:PXV:op_document_addBackground|Options|property}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| Line 14: | Line 13: | ||
| 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 data used for background generation. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
| − | | class="op_enum_value" | '''0''' (Color) || | + | | class="op_enum_value" | '''0''' (Color) || The ''Color'' will be used. |
|- | |- | ||
| − | | class="op_enum_value" | '''1''' (Image) || | + | | class="op_enum_value" | '''1''' (Image) || The image from the ''FileName'' path will be used. |
|} | |} | ||
Default value: <tt>'''0''' (Color)</tt> | Default value: <tt>'''0''' (Color)</tt> | ||
| Line 26: | Line 25: | ||
| class="op_param_name" | Color | | class="op_param_name" | Color | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the color in string presentation which 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 | + | | Specifies the number of page in the file which 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 | + | | Specifies the absolute scale value in percent which will be used if the ''UseRelativeScale'' flag is false. |
Default value: <tt>'''1.0'''</tt> | Default value: <tt>'''1.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | FileName | | class="op_param_name" | FileName | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the background image file path. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Rotation | | class="op_param_name" | Rotation | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the rotation of the background in degrees. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Opacity | | class="op_param_name" | Opacity | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the opacity of the background in percent. |
Default value: <tt>'''1.0'''</tt> | Default value: <tt>'''1.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | UseRelativeScale | | class="op_param_name" | UseRelativeScale | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the relative scale should be used. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | RelativeScale | | class="op_param_name" | RelativeScale | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the relative scale value in percent. |
Default value: <tt>'''1.0'''</tt> | Default value: <tt>'''1.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | HOffset | | class="op_param_name" | HOffset | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the horizontal offset of the background in points. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | VOffset | | class="op_param_name" | VOffset | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the vertical offset of the background in points. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | VOffsetFrom | | class="op_param_name" | VOffsetFrom | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies where the vertical offset should be made from. |
The list of possible values are shown in [[PXV:Params_NamedValues_WatermarkOffsetOrigins|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_WatermarkOffsetOrigins|the table]]. | ||
| Line 83: | Line 82: | ||
| class="op_param_name" | HOffsetFrom | | class="op_param_name" | HOffsetFrom | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies where the horizontal offset should be made from. |
The list of possible values are shown in [[PXV:Params_NamedValues_WatermarkOffsetOrigins|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_WatermarkOffsetOrigins|the table]]. | ||
| Line 90: | Line 89: | ||
| class="op_param_name" | VisibleOnView | | class="op_param_name" | VisibleOnView | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the background should be visible on view. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | VisibleOnPrint | | class="op_param_name" | VisibleOnPrint | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the background should be visible on print. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</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 background should be applied. |
|} | |} | ||
Revision as of 23:46, 26 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 which will be used if color Type is specified.
Default value: Empty String | ||||
| PageNumber | Integer | Specifies the number of page in the file which is used as background.
Default value: 1 | ||||
| AbsoluteScale | Double | Specifies the absolute scale value in percent which 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 which should be used when loading the settings of the dialog.
Default value: Empty String | ||||
| PagesRange | Dictionary | Specifies the pages range to which the background should be applied. |
