Aspose::Pdf::Facades::Bookmark class

Bookmark class

Represents a bookmark.

class Bookmark : public System::Object

Methods

MethodDescription
Bookmark()Initializes a new instance of the Bookmark class.
CompareTo(const System::SharedPtr<Bookmark>&)
get_Action() constGets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: “GoTo”, “GoToR”, “Launch”, “Named”.
get_BoldFlag() constGets the bold flag of bookmark’s title.
get_ChildItem()Gets bookmark’s children.
get_ChildItems() constGets bookmark’s children.
get_Destination() constGets bookmark’s destination page. Required if action is set as string.Empty.
get_ItalicFlag() constGets the italic flag of bookmark’s title.
get_Level() constGets bookmark’s hierarchy level.
get_Open() constGets bookmark state (open, close).
get_PageDisplay() constGets the type of display bookmark’s destination page.
get_PageDisplay_Bottom() constGets the bottom coordinate of page display.
get_PageDisplay_Left() constGets the left coordinate of page display.
get_PageDisplay_Right() constGets the right coordinate of page display.
get_PageDisplay_Top() constGets the top coordinate of page display.
get_PageDisplay_Zoom() constGets the zoom factor of page display.
get_PageNumber() constGets the number of bookmark’s destination page.
get_RemoteFile() constGets the file (path) which is required for “GoToR” action of bookmark.
get_Title() constGets bookmark’s title.
get_TitleColor() constGets the color of bookmark’s title.
set_Action(System::String)Sets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: “GoTo”, “GoToR”, “Launch”, “Named”.
set_BoldFlag(bool)Sets the bold flag of bookmark’s title.
set_ChildItem(System::SharedPtr<Bookmarks>)Sets bookmark’s children.
set_ChildItems(System::SharedPtr<Bookmarks>)Sets bookmark’s children.
set_Destination(System::String)Sets bookmark’s destination page. Required if action is set as string.Empty.
set_ItalicFlag(bool)Sets the italic flag of bookmark’s title.
set_Level(int32_t)Sets bookmark’s hierarchy level.
set_Open(bool)Sets bookmark state (open, close).
set_PageDisplay(System::String)Sets the type of display bookmark’s destination page.
set_PageDisplay_Bottom(int32_t)Sets the bottom coordinate of page display.
set_PageDisplay_Left(int32_t)Sets the left coordinate of page display.
set_PageDisplay_Right(int32_t)Sets the right coordinate of page display.
set_PageDisplay_Top(int32_t)Sets the top coordinate of page display.
set_PageDisplay_Zoom(int32_t)Sets the zoom factor of page display.
set_PageNumber(int32_t)Sets the number of bookmark’s destination page.
set_RemoteFile(System::String)Sets the file (path) which is required for “GoToR” action of bookmark.
set_Title(System::String)Sets bookmark’s title.
set_TitleColor(System::Drawing::Color)Sets the color of bookmark’s title.

See Also