ImageGear Professional for Windows ActiveX
IGPDFBookmark Object
| ImageGear Professional v18.2 > API Reference Guide > PDF Component API Reference > PDF Component Objects > General Objects > IGPDFBookmark Object |
PDF bookmark object, which allows the user to navigate interactively from one part of the document to another. It consists of a tree-structured hierarchy of bookmarks. Each bookmark has:
The typical action for a user-created bookmark is to move to another location in the current document or outside of it. Each bookmark in the bookmark tree structure has zero or more children that appear indented on screen, and zero or more siblings that appear at the same indentation level. All bookmarks except the bookmark at the top level of the hierarchy have one parent, the bookmark under which it is indented. A bookmark is said to be open if its children are visible on screen, and closed if they are not. See section 8.2.2, "Document Outline," in the PDF Reference for more information on bookmarks.
IIGPDFBookmark extends IIGObject
| AddChild Method | Adds Child as the last child of parent, |
| AddNewChild Method | Adds a new bookmark to the tree containing the current bookmark, as the new last child of it. |
| AddNewSibling Method | Adds a new bookmark to the tree containing the current bookmark as the new right sibling. |
| AddNext Method | Adds Next as the new right sibling to the current one. |
| AddPrev Method | Adds Prev as the new left sibling to the current bookmark, adjusting the tree containing the current bookmark appropriately. |
| AddSubtree Method | Adds a copy of the bookmark sub-tree source to the current bookmark, as a new last child of the current bookmark. |
| FindTitle Method | Gets the first bookmark whose title is Title. |
| GetAction Method | Gets the bookmark's action. |
| GetColor Method | Gets the color of the bookmark. |
| GetFirstChild Method | Gets the bookmark's first child. |
| GetLastChild Method | Gets the bookmark's last child. |
| GetNext Method | Gets the bookmark's next (right) sibling. |
| GetParent Method | Gets the bookmark's parent bookmark. |
| GetPrev Method | Gets the bookmark 's previous (left) sibling. |
| Remove Method | Removes the bookmark's sub-tree from the bookmark tree containing it. |
| RemoveAction Method | Removes the bookmark's action. |
| SetAction Method | Sets the bookmark's action. |
| SetColor Method | Sets the bookmark's color. |
| Unlink Method | Unlinks the current bookmark from the bookmark tree that contains it, and adjusts the tree appropriately. |
| Count Property | Number of open bookmarks in the sub-tree (not including the current one). |
| Flags Property | Bookmark's flags. |
| HasChildren Property | True if the bookmark has any children, False otherwise. |
| Indent Property | The indentation level of the bookmark in its containing tree. |
| Open Property | True if the bookmark is open (shows all its children), |
| Title Property | String specifying the bookmark's title. |