IPXC_Bookmark Interface

From PDF XChange PDF SDK
Jump to: navigation, search
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IPXC_Bookmark Interface}}
 
{{#customTitle:IPXC_Bookmark Interface}}
 +
{{#parentPage:PXV:PXC_Interfaces|IPXC_Bookmark|interface}}
  
The interface of object of PDF-XChange Editor SDK.
+
 
 +
The interface of an IPXC_Bookmark 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]]
 
| ...
 
|-
 
 
| [[PXV:IPXC_Bookmark_AddSibling|AddSibling]]
 
| [[PXV:IPXC_Bookmark_AddSibling|AddSibling]]
| ...
 
|-
 
| [[PXV:IPXC_Bookmark_Clone|Clone]]
 
| ...
 
|-
 
 
| [[PXV:IPXC_Bookmark_IsEqual|IsEqual]]
 
| [[PXV:IPXC_Bookmark_IsEqual|IsEqual]]
| ...
+
|  
|-
+
| [[PXV:IPXC_Bookmark_Unlink|Unlink]]
+
| ...
+
 
|}
 
|}
  
 
== 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 (right) 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 (left) 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.
+
 
|}
 
|}
 +
 +
== See Also ==
 +
[[PXV:IPXC_Document_BookmarkRoot|IPXC_Document::BookmarkRoot]], [[PXV:IPXV_Document_FireBookmarkChangedEvent|IPXV_Document::FireBookmarkChangedEvent]], [[PXV:IPXV_Document_FireBookmarkDeletedEvent|IPXV_Document::FireBookmarkDeletedEvent]], [[PXV:IPXV_Document_FireBookmarkInsertedEvent|IPXV_Document::FireBookmarkInsertedEvent]], [[PXV:IPXV_Document_InvalidateBookmark|IPXV_Document::InvalidateBookmark]], [[PXV:IPXV_BookmList_Find|IPXV_BookmList::Find]], [[PXV:IPXV_BookmList_Insert|IPXV_BookmList::Insert]], [[PXV:IPXV_BookmList_Remove2|IPXV_BookmList::Remove2]], [[PXV:IPXV_BookmList_Item|IPXV_BookmList::Item]], [[PXV:IPXV_BookmarksView_ShowBookmark|IPXV_BookmarksView::ShowBookmark]], [[PXV:IPXV_BookmarksView_StartRenameBookmark|IPXV_BookmarksView::StartRenameBookmark]], [[PXV:IPXV_SearchEntryItem_ContextBookmark|IPXV_SearchEntryItem::ContextBookmark]]

Latest revision as of 10:48, 10 June 2015


The interface of an IPXC_Bookmark 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

See Also

IPXC_Document::BookmarkRoot, IPXV_Document::FireBookmarkChangedEvent, IPXV_Document::FireBookmarkDeletedEvent, IPXV_Document::FireBookmarkInsertedEvent, IPXV_Document::InvalidateBookmark, IPXV_BookmList::Find, IPXV_BookmList::Insert, IPXV_BookmList::Remove2, IPXV_BookmList::Item, IPXV_BookmarksView::ShowBookmark, IPXV_BookmarksView::StartRenameBookmark, IPXV_SearchEntryItem::ContextBookmark