Class to access a PDF bookmark. More...
Public Member Functions | |
Bookmark^ | GetFirstChild () |
Get the first child bookmark. More... | |
Bookmark^ | GetNextSibling () |
Get the next sibling bookmark. More... | |
Destination^ | GetDestination () |
Get the destination data directly. More... | |
int32 | CountActions () |
Count the actions. More... | |
Action^ | GetAction (int32 index) |
Get an action by index. More... | |
Properties | |
String^ | Title |
Property: bookmark title. | |
uint32 | Color |
Property: bookmark color, which is used for displaying title. Format:0xAARRGGBB and alpha component is omitted (alpha default value: 0xFF). | |
uint32 | Status |
Property: bookmark status. Please refer to enumeration PDF::BookmarkStatus and this should be one or combination of its values. | |
int64 | pointer |
Pointer to a handle of PDF bookmark object. This pointer is not useful outside this SDK. The application should not access the pointer to the handle of the PDF bookmark object directly. | |
Class to access a PDF bookmark.
PDF bookmark is also called outline. It allows user to navigate PDF document easily by selecting one outline. One bookmark contains a destination or actions to indicate how to response when user selects it. PDF bookmark is a tree-structured hierarchy.
In order to access to the bookmark tree, function Document::GetBookmarkRoot must be called first to get the root of the whole bookmark tree. Here, "root bookmark" is an abstract object. "root bookmark" can only have some child bookmarks but no next sibling bookmarks or any data (including bookmark data, destination data and action data). And "root bookmark" cannot be shown on the application UI since it has no data. So, for a root bookmark, only function Bookmark::GetFirstChild can be used.
After the root bookmark is retrieved, following functions can be called to access other bookmarks:
int32 Foxit::PDF::Bookmark::CountActions | ( | ) |
Count the actions.
Since root bookmark is an abstract object, it doesn't have any actions or other bookmark informations. Please refer to comment of class PDF::Bookmark for more details.
Action ^ Foxit::PDF::Bookmark::GetAction | ( | int32 | index | ) |
Get an action by index.
[in] | index | Index of action to be retrieved. Range: [0, (actioncount-1)]. actioncount is returned by function Bookmark::CountActions. |
Destination ^ Foxit::PDF::Bookmark::GetDestination | ( | ) |
Get the destination data directly.
This function can get the destination data directly, without through action. If no destination can be retrieved, that may means current bookmark contains actions which are not used to go to somewhere. Please try function Bookmark::GetAction.
Bookmark ^ Foxit::PDF::Bookmark::GetFirstChild | ( | ) |
Get the first child bookmark.
Bookmark ^ Foxit::PDF::Bookmark::GetNextSibling | ( | ) |
Get the next sibling bookmark.