Bookmark interface¶
The Bookmark interface allows for the extraction of the hierarchical navigation data for a document. Bookmarks are either extracted directly from the document, or generated from the heading style information
To obtain this interface, call the Extractor.GetRootBookmark method.
| Bookmark::Action property | The Action property returns the behavior when a user clicks the bookmark. |
| Bookmark::AddChild method | The AddMethod adds a new bookmark as a child of this bookmark. |
| Bookmark::Color property | Returns the color that the bookmark should be shown. |
| Bookmark::Destination property | The Destination property returns a Unicode string for the destination of this bookmark. The destination value is based on the Action type of the bookmark. |
| Bookmark::Fit property | The Fit property returns the zoom/fit level that should be applied when navigating to the destination. |
| Bookmark::GetFirstChild property | The GetFirstChild method returns the first child bookmark of the current node, or NULL if the node contains no children. |
| Bookmark::GetNextSibling property | The GetNextSibling method returns the next peer bookmark of the current node, or NULL if the node is the last in it’s chain. |
| Bookmark::Height property | The Height property return the dimensions on the page where the user should be zoomed into. The dimension information is based on the DPI used when loading the page. |
| Bookmark::Level property | The Level property returns the depth in the hierarchy of the current bookmark. |
| Bookmark::PageIndex property | The PageIndex property returns the index of the page to navigate to when the Action is GoTo, otherwise it returns -1. |
| Bookmark::Rect property | Returns the destination rectangle of the bookmark. |
| Bookmark::TextStyle property | Returns any text styling that should be applied when showing the bookmark title; see Text Styles for details. |
| Bookmark::Title property | The Title property returns a Unicode string for the title of this bookmark. |
| Bookmark::Width property | The Width property return the dimensions on the page where the user should be zoomed into. The dimension information is based on the DPI used hen loading the page. |
| Bookmark::X property | The X property return the position on the page where the user should be scrolled to. The position information is based on the DPI used when loading the page. |
| Bookmark::Y property | The Y property return the position on the page where the user should be scrolled to. The position information is based on the DPI used when loading the page. |
| Bookmark::Zoom property | The Zoom property returns the zoom/fit level that should be applied when navigating to the destination. |