Options
From PDF XChange PDF SDK
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: 0 | ||||
| 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 an unique identifier of special preset of options that exists in Editor's settings. End-user may create multiple presets for different operations to enhance convenience of using. If specified preset already exists then operation will use preset's options to show dialog or perform its work.
Default value: Empty String | ||||
| PagesRange | Dictionary | Specifies the pages range which the background should be applied to. |
