Options
From PDF XChange PDF SDK
(Automatic page editing by robot) |
(→Options Table) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:Options}} | {{#customTitle:Options}} | ||
{{#parentPage:PXV:op_annots_setProps|Options|property}} | {{#parentPage:PXV:op_annots_setProps|Options|property}} | ||
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| Line 14: | Line 14: | ||
| class="op_param_name" | Mask | | class="op_param_name" | Mask | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the annotation modification [[PXV:PXV_OpModifyAnnotMaskFlags|mask flags]]. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | MaskEx | | class="op_param_name" | MaskEx | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the extended annotation modification [[PXV:PXV_OpModifyAnnotMaskExFlags|mask flags]]. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Flags | | class="op_param_name" | Flags | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the [[PXV:PXC_AnnotFlag|flags]] used for the modification. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | FlagsMask | | class="op_param_name" | FlagsMask | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the mask used for the [[PXV:PXC_AnnotFlag|flags]]. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[PXV:cs_AnnotBorder|Border]] | | class="op_param_name" | [[PXV:cs_AnnotBorder|Border]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the annotation border's settings. |
|- | |- | ||
| class="op_param_name" | SColor | | class="op_param_name" | SColor | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the annotations' stroke color. |
Default value: <tt>'''rgb(0,0,0)'''</tt> | Default value: <tt>'''rgb(0,0,0)'''</tt> | ||
|- | |- | ||
| class="op_param_name" | FColor | | class="op_param_name" | FColor | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the annotations' fill color. |
Default value: <tt>'''rgb(0,0,0)'''</tt> | Default value: <tt>'''rgb(0,0,0)'''</tt> | ||
|- | |- | ||
| class="op_param_name" | NoteIcon | | class="op_param_name" | NoteIcon | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the icon type that should be used for annotations' notes. |
The list of possible values are shown in [[PXV:Params_NamedValues_NoteIconTypes|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_NoteIconTypes|the table]]. | ||
| Line 55: | Line 55: | ||
| class="op_param_name" | TextMarkupType | | class="op_param_name" | TextMarkupType | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the text markup type that should be used. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
| − | | class="op_enum_value" | '''2908''' (Highlight) | + | | class="op_enum_value" | '''2908''' (Highlight) |
|- | |- | ||
| − | | class="op_enum_value" | '''5653''' (Squiggly) | + | | class="op_enum_value" | '''5653''' (Squiggly) |
|- | |- | ||
| − | | class="op_enum_value" | '''5696''' (StrikeOut) | + | | class="op_enum_value" | '''5696''' (StrikeOut) |
|- | |- | ||
| − | | class="op_enum_value" | '''6278''' (Underline) | + | | class="op_enum_value" | '''6278''' (Underline) |
|} | |} | ||
Default value: <tt>'''2908''' (Highlight)</tt> | Default value: <tt>'''2908''' (Highlight)</tt> | ||
| Line 71: | Line 71: | ||
| class="op_param_name" | Opacity | | class="op_param_name" | Opacity | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the opacity value that should be used (100% by default). |
Default value: <tt>'''1.0'''</tt> | Default value: <tt>'''1.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Author | | class="op_param_name" | Author | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the annotations' author. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Subject | | class="op_param_name" | Subject | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the annotations' subject. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| 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 would be set to the annotations that use it. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | RichText | | class="op_param_name" | RichText | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the rich text that would be set to the annotations that use it. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | LS | | class="op_param_name" | LS | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the line starting style that should be used. |
The list of possible values are shown in [[PXV:Params_NamedValues_LineEndingStyles|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_LineEndingStyles|the table]]. | ||
| Line 103: | Line 103: | ||
| class="op_param_name" | LE | | class="op_param_name" | LE | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the line ending style that should be used. |
The list of possible values are shown in [[PXV:Params_NamedValues_LineEndingStyles|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_LineEndingStyles|the table]]. | ||
| Line 110: | Line 110: | ||
| class="op_param_name" | LLO | | class="op_param_name" | LLO | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the line leader offset value. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | LLL | | class="op_param_name" | LLL | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the line leader length value. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | LLE | | class="op_param_name" | LLE | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the line leader extension value. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | LCV | | class="op_param_name" | LCV | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the line caption should be visible. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | LCI | | class="op_param_name" | LCI | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the line caption should be inline. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | [[PXV:cs_PointF|LCO]] | | class="op_param_name" | [[PXV:cs_PointF|LCO]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the line caption offset value. |
|- | |- | ||
| class="op_param_name" | LineLength | | class="op_param_name" | LineLength | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the line length value. |
Default value: <tt>'''72.0'''</tt> | Default value: <tt>'''72.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | LCP | | class="op_param_name" | LCP | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the line caption position. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
| − | | class="op_enum_value" | '''0''' (Inline) || | + | | class="op_enum_value" | '''0''' (Inline) || The line caption will be inline. |
|- | |- | ||
| − | | class="op_enum_value" | '''1''' (Top) || | + | | class="op_enum_value" | '''1''' (Top) || The line caption will be placed at the annotation's top. |
|} | |} | ||
Default value: <tt>'''0''' (Inline)</tt> | Default value: <tt>'''0''' (Inline)</tt> | ||
| Line 156: | Line 156: | ||
| class="op_param_name" | HighlightMode | | class="op_param_name" | HighlightMode | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the highlight mode that should be applied to the annotations. |
Possible values are: | Possible values are: | ||
{| class="op_internal_table" | {| class="op_internal_table" | ||
|- | |- | ||
| − | | class="op_enum_value" | '''0''' (None) || | + | | class="op_enum_value" | '''0''' (None) || No highlight would be applied. |
|- | |- | ||
| − | | class="op_enum_value" | '''1''' (Invert) || | + | | class="op_enum_value" | '''1''' (Invert) || The current highlight value will be inverted. |
|- | |- | ||
| class="op_enum_value" | '''2''' (Outline) || ... | | class="op_enum_value" | '''2''' (Outline) || ... | ||
| Line 174: | Line 174: | ||
| class="op_param_name" | BlendMode | | class="op_param_name" | BlendMode | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the annotations' blend mode. |
The list of possible values are shown in [[PXV:Params_NamedValues_BlendModes|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_BlendModes|the table]]. | ||
| Line 181: | Line 181: | ||
| class="op_param_name" | Trigger | | class="op_param_name" | Trigger | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the annotations' action trigger that would execute the action list. |
The list of possible values are shown in [[PXV:Params_NamedValues_ActionTriggers|the table]]. | The list of possible values are shown in [[PXV:Params_NamedValues_ActionTriggers|the table]]. | ||
| Line 188: | Line 188: | ||
| class="op_param_name" | Actions | | class="op_param_name" | Actions | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies | + | | Specifies the action list that would be executed by the trigger. |
|- | |- | ||
| class="op_param_name" | [[PXV:cs_PDFDestParams|Dest]] | | class="op_param_name" | [[PXV:cs_PDFDestParams|Dest]] | ||
| style="text-align:center" | Dictionary | | style="text-align:center" | Dictionary | ||
| − | | Specifies | + | | Specifies the annotations' destination parameters. |
|- | |- | ||
| class="op_param_name" | Name | | class="op_param_name" | Name | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the annotations' names. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | ModDate | | class="op_param_name" | ModDate | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the new modification date of the annotations. |
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 annotations' rotation angle. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | AbsRotation | | class="op_param_name" | AbsRotation | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies. | + | | Specifies whether the rotation should be added to the previous rotations. If '''true''' is specified then the Rotation value will replace the previous rotation value. |
Default value: <tt>'''true'''</tt> | Default value: <tt>'''true'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Measure | | class="op_param_name" | Measure | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies | + | | Specifies the annotations' [[PXV:IPXC_Measure|measure]]. |
|- | |- | ||
| class="op_param_name" | DefStyle | | class="op_param_name" | DefStyle | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the annotations' default style. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | OFC | | class="op_param_name" | OFC | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the |
Default value: <tt>'''gray(0)'''</tt> | Default value: <tt>'''gray(0)'''</tt> | ||
|- | |- | ||
| Line 245: | Line 245: | ||
| class="op_param_name" | DefFontID | | class="op_param_name" | DefFontID | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the annotations' default font ID. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | DefFontSize | | class="op_param_name" | DefFontSize | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the annotations' default font size. |
Default value: <tt>'''10.0'''</tt> | Default value: <tt>'''10.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | DefTextColor | | class="op_param_name" | DefTextColor | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the annotations' default text color. |
Default value: <tt>'''rgbd(0,0,0)'''</tt> | Default value: <tt>'''rgbd(0,0,0)'''</tt> | ||
|- | |- | ||
| class="op_param_name" | DefTextAlign | | class="op_param_name" | DefTextAlign | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the annotations' default text align. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| Line 269: | Line 269: | ||
| class="op_param_name" | LSS | | class="op_param_name" | LSS | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the annotations' line-ending start scale. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | LES | | class="op_param_name" | LES | ||
| style="text-align:center" | Double | | style="text-align:center" | Double | ||
| − | | Specifies | + | | Specifies the annotations' line-ending end scale. |
Default value: <tt>'''0.0'''</tt> | Default value: <tt>'''0.0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Opened | | class="op_param_name" | Opened | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies... | + | | Specifies whether the annotations will be in the open state. |
| − | Default value: <tt>''' | + | |- |
| + | | class="op_param_name" | LineWidthProfile | ||
| + | | style="text-align:center" | Integer | ||
| + | | Specifies the line width profile type. The ID is the selection ID from the Width Profile combo box (0 is auto). | ||
| + | Default value: <tt>'''0.0'''</tt> | ||
|} | |} | ||
Latest revision as of 08:45, 23 October 2020
Options Table
| Name | Type | Value | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Mask | Integer | Specifies the annotation modification mask flags.
Default value: 0 | ||||||||||
| MaskEx | Integer | Specifies the extended annotation modification mask flags.
Default value: 0 | ||||||||||
| Flags | Integer | Specifies the flags used for the modification.
Default value: 0 | ||||||||||
| FlagsMask | Integer | Specifies the mask used for the flags.
Default value: -1 | ||||||||||
| Border | Dictionary | Specifies the annotation border's settings. | ||||||||||
| SColor | String | Specifies the annotations' stroke color.
Default value: rgb(0,0,0) | ||||||||||
| FColor | String | Specifies the annotations' fill color.
Default value: rgb(0,0,0) | ||||||||||
| NoteIcon | Integer | Specifies the icon type that should be used for annotations' notes.
The list of possible values are shown in the table. Default value: 3 (Comment) | ||||||||||
| TextMarkupType | Integer | Specifies the text markup type that should be used.
Possible values are:
Default value: 2908 (Highlight) | ||||||||||
| Opacity | Double | Specifies the opacity value that should be used (100% by default).
Default value: 1.0 | ||||||||||
| Author | String | Specifies the annotations' author.
Default value: Empty String | ||||||||||
| Subject | String | Specifies the annotations' subject.
Default value: Empty String | ||||||||||
| Text | String | Specifies the text that would be set to the annotations that use it.
Default value: Empty String | ||||||||||
| RichText | String | Specifies the rich text that would be set to the annotations that use it.
Default value: Empty String | ||||||||||
| LS | Integer | Specifies the line starting style that should be used.
The list of possible values are shown in the table. Default value: 0 (None) | ||||||||||
| LE | Integer | Specifies the line ending style that should be used.
The list of possible values are shown in the table. Default value: 0 (None) | ||||||||||
| LLO | Double | Specifies the line leader offset value.
Default value: 0.0 | ||||||||||
| LLL | Double | Specifies the line leader length value.
Default value: 0.0 | ||||||||||
| LLE | Double | Specifies the line leader extension value.
Default value: 0.0 | ||||||||||
| LCV | Boolean | Specifies whether the line caption should be visible.
Default value: true | ||||||||||
| LCI | Boolean | Specifies whether the line caption should be inline.
Default value: true | ||||||||||
| LCO | Dictionary | Specifies the line caption offset value. | ||||||||||
| LineLength | Double | Specifies the line length value.
Default value: 72.0 | ||||||||||
| LCP | Integer | Specifies the line caption position.
Possible values are:
Default value: 0 (Inline) | ||||||||||
| HighlightMode | Integer | Specifies the highlight mode that should be applied to the annotations.
Possible values are:
Default value: 1 (Invert) | ||||||||||
| BlendMode | Integer | Specifies the annotations' blend mode.
The list of possible values are shown in the table. Default value: 0 (Normal) | ||||||||||
| Trigger | Integer | Specifies the annotations' action trigger that would execute the action list.
The list of possible values are shown in the table. Default value: 4 (Up) | ||||||||||
| Actions | IUnknown | Specifies the action list that would be executed by the trigger. | ||||||||||
| Dest | Dictionary | Specifies the annotations' destination parameters. | ||||||||||
| Name | String | Specifies the annotations' names.
Default value: Empty String | ||||||||||
| ModDate | String | Specifies the new modification date of the annotations.
Default value: Empty String | ||||||||||
| Rotation | Double | Specifies the annotations' rotation angle.
Default value: 0.0 | ||||||||||
| AbsRotation | Boolean | Specifies whether the rotation should be added to the previous rotations. If true is specified then the Rotation value will replace the previous rotation value.
Default value: true | ||||||||||
| Measure | IUnknown | Specifies the annotations' measure. | ||||||||||
| DefStyle | String | Specifies the annotations' default style.
Default value: Empty String | ||||||||||
| OFC | String | Specifies the
Default value: gray(0) | ||||||||||
| OT | String | Specifies...
Default value: Empty String | ||||||||||
| ORT | Boolean | Specifies...
Default value: false | ||||||||||
| DefFontName | String | Specifies...
Default value: Empty String | ||||||||||
| DefFontID | Integer | Specifies the annotations' default font ID.
Default value: -1 | ||||||||||
| DefFontSize | Double | Specifies the annotations' default font size.
Default value: 10.0 | ||||||||||
| DefTextColor | String | Specifies the annotations' default text color.
Default value: rgbd(0,0,0) | ||||||||||
| DefTextAlign | Integer | Specifies the annotations' default text align.
Default value: 0 | ||||||||||
| OC | IUnknown | Specifies... | ||||||||||
| LSS | Double | Specifies the annotations' line-ending start scale.
Default value: 0.0 | ||||||||||
| LES | Double | Specifies the annotations' line-ending end scale.
Default value: 0.0 | ||||||||||
| Opened | Boolean | Specifies whether the annotations will be in the open state. | ||||||||||
| LineWidthProfile | Integer | Specifies the line width profile type. The ID is the selection ID from the Width Profile combo box (0 is auto).
Default value: 0.0 |
