IPXC_Bookmark Interface

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 1: Line 1:
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Bookmark Interface}}
 
{{#customTitle:IPXC_Bookmark Interface}}
 +
{{ToWrite}}
 +
{{ToReview}}
  
 
The interface of object of PDF-XChange Editor SDK.
 
The interface of object of PDF-XChange Editor SDK.
  
 
== Methods ==
 
== Methods ==
−
{| class="wikitable sortable collapsible" style="width: 100%"
+
{| class="wikitable methods"
−
|-
+
−
! style="text-align: left" scope="col" width="15%" | Method
+
−
! style="text-align: left" scope="col" class="unsortable" | Description
+
 
|-
 
|-
 
| [[PXV:IPXC_Bookmark_AddChild|AddChild]]
 
| [[PXV:IPXC_Bookmark_AddChild|AddChild]]
−
| Adds an existing bookmark as a child to the bookmark's sub-tree.
+
| [[PXV:IPXC_Bookmark_AddNewSibling|AddNewSibling]]
 +
| [[PXV:IPXC_Bookmark_Clone|Clone]]
 +
| [[PXV:IPXC_Bookmark_Unlink|Unlink]]
 
|-
 
|-
 
| [[PXV:IPXC_Bookmark_AddNewChild|AddNewChild]]
 
| [[PXV:IPXC_Bookmark_AddNewChild|AddNewChild]]
−
| Creates new bookmark and inserts it as a child in the bookmark's sub-tree.
 
−
|-
 
−
| [[PXV:IPXC_Bookmark_AddNewSibling|AddNewSibling]]
 
−
| Creates new bookmark and inserts it as a bookmark's sibling (before or after it on the same level).
 
−
|-
 
 
| [[PXV:IPXC_Bookmark_AddSibling|AddSibling]]
 
| [[PXV:IPXC_Bookmark_AddSibling|AddSibling]]
−
| Adds an existing bookmark as a sibling to the bookmark.
 
−
|-
 
−
| [[PXV:IPXC_Bookmark_Clone|Clone]]
 
−
| Creates new entity as an exact copy of the bookmark.
 
−
|-
 
 
| [[PXV:IPXC_Bookmark_IsEqual|IsEqual]]
 
| [[PXV:IPXC_Bookmark_IsEqual|IsEqual]]
−
| Checks whether the given bookmark is equal to the source bookmark.
+
|  
−
|-
+
−
| [[PXV:IPXC_Bookmark_Unlink|Unlink]]
+
−
| Unlinks a bookmark from the bookmark tree that contains it.
+
 
|}
 
|}
  
 
== Properties ==
 
== Properties ==
−
{| style="width: 100%" class="wikitable sortable collapsible"
+
{| class="wikitable properties"
−
|-
+
−
! style="text-align: left" scope="col" width="15%" | Property
+
−
! style="text-align: center" scope="col" width="5%" | Access Type
+
−
! style="text-align: left" scope="col"  class="unsortable" | Description
+
 
|-
 
|-
 
| [[PXV:IPXC_Bookmark_Actions|Actions]]
 
| [[PXV:IPXC_Bookmark_Actions|Actions]]
−
| style="text-align: center" | R/W
+
| [[PXV:IPXC_Bookmark_FirstChild|FirstChild]]
−
| Gets/sets [[PXV:IPXC_ActionsList|actions list]] of the bookmark.
+
| [[PXV:IPXC_Bookmark_Opened|Opened]]
 +
| [[PXV:IPXC_Bookmark_Previous|Previous]]
 
|-
 
|-
 
| [[PXV:IPXC_Bookmark_ChildrenCount|ChildrenCount]]
 
| [[PXV:IPXC_Bookmark_ChildrenCount|ChildrenCount]]
−
| style="text-align: center" | R
+
| [[PXV:IPXC_Bookmark_Indent|Indent]]
−
| Gets number of bookmarks in a sub-tree.
+
| [[PXV:IPXC_Bookmark_Parent|Parent]]
 +
| [[PXV:IPXC_Bookmark_Style|Style]]
 
|-
 
|-
 
| [[PXV:IPXC_Bookmark_Color|Color]]
 
| [[PXV:IPXC_Bookmark_Color|Color]]
−
| style="text-align: center" | R/W
+
| [[PXV:IPXC_Bookmark_LastChild|LastChild]]
−
| Gets/sets [[PXV:IColor|color]] of the bookmark.
+
| [[PXV:IPXC_Bookmark_PDFObject|PDFObject]]
 +
| [[PXV:IPXC_Bookmark_Title|Title]]
 
|-
 
|-
 
| [[PXV:IPXC_Bookmark_Document|Document]]
 
| [[PXV:IPXC_Bookmark_Document|Document]]
−
| style="text-align: center" | R
 
−
| Gets [[PXV:IPXC_Document|document]] that bookmark belongs to.
 
−
|-
 
−
| [[PXV:IPXC_Bookmark_FirstChild|FirstChild]]
 
−
| style="text-align: center" | R
 
−
| Gets first element in the sub-tree of the bookmark.
 
−
|-
 
−
| [[PXV:IPXC_Bookmark_Indent|Indent]]
 
−
| style="text-align: center" | R
 
−
| Gets the indentation level of the bookmark in its containing tree.
 
−
|-
 
−
| [[PXV:IPXC_Bookmark_LastChild|LastChild]]
 
−
| style="text-align: center" | R
 
−
| Gets last element in the sub-tree of the bookmark.
 
−
|-
 
 
| [[PXV:IPXC_Bookmark_Next|Next]]
 
| [[PXV:IPXC_Bookmark_Next|Next]]
−
| style="text-align: center" | R
+
|  
−
| Gets bookmark's next sibling.
+
|  
−
|-
+
−
| [[PXV:IPXC_Bookmark_Opened|Opened]]
+
−
| style="text-align: center" | R/W
+
−
| Gets/sets bookmark's open state.
+
−
|-
+
−
| [[PXV:IPXC_Bookmark_Parent|Parent]]
+
−
| style="text-align: center" | R
+
−
| Gets bookmark's parent bookmark.
+
−
|-
+
−
| [[PXV:IPXC_Bookmark_PDFObject|PDFObject]]
+
−
| style="text-align: center" | R
+
−
| Gets bookmark's [[PXV:IPXS_PDFVariant|object]] from the PDF structure.
+
−
|-
+
−
| [[PXV:IPXC_Bookmark_Previous|Previous]]
+
−
| style="text-align: center" | R
+
−
| Gets bookmark's previous sibling.
+
−
|-
+
−
| [[PXV:IPXC_Bookmark_Style|Style]]
+
−
| style="text-align: center" | R/W
+
−
| Gets/sets bookmark's [[PXV:PXC_BookmarkStyle|style]].
+
−
|-
+
−
| [[PXV:IPXC_Bookmark_Title|Title]]
+
−
| style="text-align: center" | R/W
+
−
| Gets/sets bookmark's title.
+
 
|}
 
|}

Revision as of 14:42, 20 April 2015


The interface of object of PDF-XChange Editor SDK.

Methods

AddChild AddNewSibling Clone Unlink
AddNewChild AddSibling IsEqual

Properties

Actions FirstChild Opened Previous
ChildrenCount Indent Parent Style
Color LastChild PDFObject Title
Document Next
Retrieved from "https://sdkhelp.pdf-xchange.com/index.php?title=PXV:IPXC_Bookmark&oldid=6994"