Options
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| Line 2: | Line 2: | ||
{{#customTitle:Options}} | {{#customTitle:Options}} | ||
{{#parentPage:PXV:op_document_addWatermarks|Options|property}} | {{#parentPage:PXV:op_document_addWatermarks|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''' (Text) || | + | | class="op_enum_value" | '''0''' (Text) || The ''Text'' 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''' (Text)</tt> | Default value: <tt>'''0''' (Text)</tt> | ||
| Line 26: | Line 25: | ||
| class="op_param_name" | Text | | class="op_param_name" | Text | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the text that will be used as a watermark. |
Default value: <tt>'''Watermark Sample'''</tt> | Default value: <tt>'''Watermark Sample'''</tt> | ||
|- | |- | ||
| 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 that will be used when placing a watermark with text type. |
|- | |- | ||
| class="op_param_name" | TextAlign | | class="op_param_name" | TextAlign | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the align of the text in placed watermark. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''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 watermark image file path. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | ImagePage | | class="op_param_name" | ImagePage | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the number of page in the file that is used as a watermark. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</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 placed watermark in degrees. |
Default value: <tt>'''45.0'''</tt> | Default value: <tt>'''45.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 watermark in percent. |
Default value: <tt>'''25.0'''</tt> | Default value: <tt>'''25.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. |
Default value: <tt>'''100.0'''</tt> | Default value: <tt>'''100.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 watermark 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 watermark 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 87: | Line 86: | ||
| 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 94: | Line 93: | ||
| class="op_param_name" | AsBackground | | class="op_param_name" | AsBackground | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the watermark should be placed as background. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|- | |- | ||
| class="op_param_name" | VisibleOnView | | class="op_param_name" | VisibleOnView | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the watermark will 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 watermark will be visible on print. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | VisibleOnExport | | class="op_param_name" | VisibleOnExport | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the watermark will be visible on export. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | OffsetsInPercent | | class="op_param_name" | OffsetsInPercent | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the offset values are entered as percent values. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</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 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 | + | | Specifies the pages range which the watermark should be applied to. |
|- | |- | ||
| class="op_param_name" | WatermarkID | | class="op_param_name" | WatermarkID | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies. | + | | 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: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|} | |} | ||
Revision as of 06:04, 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 (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 |
