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 (Text) | ||||
| Text | String | Specifies the text that will be used as a watermark.
Default value: Watermark Sample | ||||
| Font | Dictionary | Specifies the font that will be used when placing a watermark with text type. | ||||
| TextAlign | Integer | Specifies the align of the text in placed watermark.
Default value: 0 | ||||
| FileName | String | Specifies the watermark image file path.
Default value: Empty String | ||||
| ImagePage | Integer | Specifies the number of page in the file that is used as a watermark.
Default value: 0 | ||||
| Rotation | Double | Specifies the rotation of the placed watermark in degrees.
Default value: 45.0 | ||||
| Opacity | Double | Specifies the opacity of the watermark in percent.
Default value: 25.0 | ||||
| UseRelativeScale | Boolean | Specifies whether the relative scale should be used.
Default value: true | ||||
| RelativeScale | Double | Specifies the relative scale value.
Default value: 100.0 | ||||
| HOffset | Double | Specifies the horizontal offset of the watermark in points.
Default value: 0.0 | ||||
| VOffset | Double | Specifies the vertical offset of the watermark 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) | ||||
| AsBackground | Boolean | Specifies whether the watermark should be placed as background.
Default value: false | ||||
| VisibleOnView | Boolean | Specifies whether the watermark will be visible on view.
Default value: true | ||||
| VisibleOnPrint | Boolean | Specifies whether the watermark will be visible on print.
Default value: true | ||||
| VisibleOnExport | Boolean | Specifies whether the watermark will be visible on export.
Default value: true | ||||
| OffsetsInPercent | Boolean | Specifies whether the offset values are entered as percent values.
Default value: false | ||||
| 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 watermark should be applied to. | ||||
| WatermarkID | String | Specifies the ID of the pagemark group that should be modified. If the ID is empty the watermark will be added as a new group, otherwise the group with the given ID will be modified.
Default value: Empty String |
