Options

From PDF XChange PDF SDK
Jump to: navigation, search
(Automatic page editing by robot)
 
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{#customTitle:Options}}
 
{{#customTitle:Options}}
 
{{#parentPage:PXV:op_bookmarks_addNew|Options|property}}
 
{{#parentPage:PXV:op_bookmarks_addNew|Options|property}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
Line 14: Line 13:
 
| class="op_param_name" | Title
 
| class="op_param_name" | Title
 
| style="text-align:center" | String
 
| style="text-align:center" | String
| Specifies...
+
| Specifies the title of the new 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 color of the bookmark in string representation.
 
Default value: <tt>'''rgbd(0,0,0)'''</tt>
 
Default value: <tt>'''rgbd(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" | Parent
 
| class="op_param_name" | Parent
 
| style="text-align:center" | IUnknown
 
| style="text-align:center" | IUnknown
| Specifies...
+
| Specifies the parent [[PXV:IPXC_Bookmark|IPXC_Bookmark]].
 
|-
 
|-
 
| class="op_param_name" | InsertBefore
 
| class="op_param_name" | InsertBefore
 
| style="text-align:center" | Integer
 
| style="text-align:center" | Integer
| Specifies...
+
| Specifies the bookmark before which the new bookmark will be inserted. Using the default value will insert the bookmark as the last item of the parent.
 
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.
 
|}
 
|}

Latest revision as of 02:13, 27 May 2015


Options Table

Name Type Value
Title String Specifies the title of the new bookmark.

Default value: Empty String

Color String Specifies the color of the bookmark in string representation.

Default value: rgbd(0,0,0)

Style Integer Specifies the PXC_BookmarkStyle flags of the bookmark.

Default value: 0

Parent IUnknown Specifies the parent IPXC_Bookmark.
InsertBefore Integer Specifies the bookmark before which the new bookmark will be inserted. Using the default value will insert the bookmark as the last item of the parent.

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.