Options
From PDF XChange PDF SDK
(Automatic page editing by robot) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
{{#customTitle:Options}} | {{#customTitle:Options}} | ||
{{#parentPage:PXV:op_bookmarks_setProps|Options|property}} | {{#parentPage:PXV:op_bookmarks_setProps|Options|property}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| Line 14: | Line 13: | ||
| class="op_param_name" | Mask | | class="op_param_name" | Mask | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the [[PXV:PXC_OpModifyBookmMaskFlags|PXC_OpModifyBookmMaskFlags]]. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Title | | class="op_param_name" | Title | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the new title of the bookmark. |
Default value: <tt>'''Empty String'''</tt> | Default value: <tt>'''Empty String'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Color | | class="op_param_name" | Color | ||
| style="text-align:center" | String | | style="text-align:center" | String | ||
| − | | Specifies | + | | Specifies the new color in the text representation. |
Default value: <tt>'''rgb(0,0,0)'''</tt> | Default value: <tt>'''rgb(0,0,0)'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Style | | class="op_param_name" | Style | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the [[PXV:PXC_BookmarkStyle|PXC_BookmarkStyle]] flags of the bookmark. |
Default value: <tt>'''0'''</tt> | Default value: <tt>'''0'''</tt> | ||
|- | |- | ||
| class="op_param_name" | StyleMask | | class="op_param_name" | StyleMask | ||
| style="text-align:center" | Integer | | style="text-align:center" | Integer | ||
| − | | Specifies | + | | Specifies the style mask for the style flags. |
Default value: <tt>'''-1'''</tt> | Default value: <tt>'''-1'''</tt> | ||
|- | |- | ||
| class="op_param_name" | Actions | | class="op_param_name" | Actions | ||
| style="text-align:center" | IUnknown | | style="text-align:center" | IUnknown | ||
| − | | Specifies. | + | | Specifies the [[PXV:IPXC_ActionsList|IPXC_ActionsList]] of the bookmark. Note that if the ''Actions'' and ''Dest'' parameters are both specified then only the ''Actions'' will be used. |
|- | |- | ||
| 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 destination parameters that can be used when the actions list is not specified. |
|- | |- | ||
| class="op_param_name" | IsOpened | | class="op_param_name" | IsOpened | ||
| style="text-align:center" | Boolean | | style="text-align:center" | Boolean | ||
| − | | Specifies | + | | Specifies whether the open state of the bookmark. |
Default value: <tt>'''false'''</tt> | Default value: <tt>'''false'''</tt> | ||
|} | |} | ||
Latest revision as of 01:12, 27 May 2015
Options Table
| Name | Type | Value |
|---|---|---|
| Mask | Integer | Specifies the PXC_OpModifyBookmMaskFlags.
Default value: 0 |
| Title | String | Specifies the new title of the bookmark.
Default value: Empty String |
| Color | String | Specifies the new color in the text representation.
Default value: rgb(0,0,0) |
| Style | Integer | Specifies the PXC_BookmarkStyle flags of the bookmark.
Default value: 0 |
| StyleMask | Integer | Specifies the style mask for the style flags.
Default value: -1 |
| Actions | IUnknown | Specifies the IPXC_ActionsList of the bookmark. Note that if the Actions and Dest parameters are both specified then only the Actions will be used. |
| Dest | Dictionary | Specifies the destination parameters that can be used when the actions list is not specified. |
| IsOpened | Boolean | Specifies whether the open state of the bookmark.
Default value: false |
