public final class Bookmark extends Object
Represents a bookmark.
Constructor and Description |
---|
Bookmark()
Initializes a new instance of the
Bookmark class. |
Modifier and Type | Method and Description |
---|---|
String |
getAction()
Gets the action bound with the bookmark.
|
boolean |
getBoldFlag()
Gets the bold flag of bookmark's title.
|
Bookmarks |
getChildItem()
Deprecated.
|
Bookmarks |
getChildItems()
Gets or sets bookmark's children.
|
com.aspose.ms.System.Enum[] |
getCustomAcorbatViewerMenuActionName()
Gets the action name corresponding to execute a menu item in Acrobat viewer.
|
String |
getDestination()
Gets bookmark's destination page.
|
boolean |
getItalicFlag()
Gets the italic flag of bookmark's title.
|
int |
getLevel()
Gets bookmark's hierarchy level.
|
boolean |
getOpen() |
int |
getPageDisplay_Bottom()
Gets the bottom coordinate of page display.
|
int |
getPageDisplay_Left()
Gets the left coordinate of page display.
|
int |
getPageDisplay_Right()
Gets the right coordinate of page display.
|
int |
getPageDisplay_Top()
Gets the top coordinate of page display.
|
int |
getPageDisplay_Zoom()
Gets the zoom factor of page display.
|
String |
getPageDisplay()
Gets the type of display bookmark's destination page.
|
int |
getPageNumber()
Gets the number of bookmark's destination page.
|
String |
getRemoteFile()
Gets the file (path) which is required for "GoToR" action of bookmark.
|
String |
getTitle()
Gets bookmark's title.
|
Color |
getTitleColor()
Gets the color of bookmark's title.
|
void |
setAction(String value)
Sets the action bound with the bookmark.
|
void |
setBoldFlag(boolean value)
Sets the bold flag of bookmark's title.
|
void |
setChildItem(Bookmarks value)
Deprecated.
|
void |
setChildItems(Bookmarks value) |
void |
setCustomAcorbatViewerMenuActionName(com.aspose.ms.System.Enum[] value)
Sets the action name corresponding to execute a menu item in Acrobat viewer.
|
void |
setDestination(String value)
Sets bookmark's destination page.
|
void |
setItalicFlag(boolean value)
Sets the italic flag of bookmark's title.
|
void |
setLevel(int value)
Sets bookmark's hierarchy level.
|
void |
setOpen(boolean value) |
void |
setPageDisplay_Bottom(int value)
Sets the bottom coordinate of page display.
|
void |
setPageDisplay_Left(int value)
Sets the left coordinate of page display.
|
void |
setPageDisplay_Right(int value)
Sets the right coordinate of page display.
|
void |
setPageDisplay_Top(int value)
Sets the top coordinate of page display.
|
void |
setPageDisplay_Zoom(int value)
Sets the zoom factor of page display.
|
void |
setPageDisplay(String value)
Sets the type of display bookmark's destination page.
|
void |
setPageNumber(int value)
Sets the number of bookmark's destination page.
|
void |
setRemoteFile(String value)
Sets the file (path) which is required for "GoToR" action of bookmark.
|
void |
setTitle(String value)
Sets bookmark's title.
|
void |
setTitleColor(Color value)
Sets the color of bookmark's title.
|
OutlineItemCollection |
toOutlineItemCollection(IDocument doc) |
public OutlineItemCollection toOutlineItemCollection(IDocument doc)
public String getAction()
Gets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: "GoTo", "GoToR", "Launch", "Named".
public void setAction(String value)
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".
public boolean getBoldFlag()
Gets the bold flag of bookmark's title.
public void setBoldFlag(boolean value)
Sets the bold flag of bookmark's title.
@Deprecated public Bookmarks getChildItem()
Gets bookmark's children.
@Deprecated public void setChildItem(Bookmarks value)
Sets bookmark's children.
public Bookmarks getChildItems()
Gets or sets bookmark's children.
public void setChildItems(Bookmarks value)
public com.aspose.ms.System.Enum[] getCustomAcorbatViewerMenuActionName()
Gets the action name corresponding to execute a menu item in Acrobat viewer.
public void setCustomAcorbatViewerMenuActionName(com.aspose.ms.System.Enum[] value)
Sets the action name corresponding to execute a menu item in Acrobat viewer.
public String getDestination()
Gets bookmark's destination page. Required if action is set as "".
public void setDestination(String value)
Sets bookmark's destination page. Required if action is set as "".
public boolean getItalicFlag()
Gets the italic flag of bookmark's title.
public void setItalicFlag(boolean value)
Sets the italic flag of bookmark's title.
public int getLevel()
Gets bookmark's hierarchy level.
public void setLevel(int value)
Sets bookmark's hierarchy level.
public String getPageDisplay()
Gets the type of display bookmark's destination page.
public void setPageDisplay(String value)
Sets the type of display bookmark's destination page.
public int getPageDisplay_Bottom()
Gets the bottom coordinate of page display.
public void setPageDisplay_Bottom(int value)
Sets the bottom coordinate of page display.
public int getPageDisplay_Left()
Gets the left coordinate of page display.
public void setPageDisplay_Left(int value)
Sets the left coordinate of page display.
public int getPageDisplay_Right()
Gets the right coordinate of page display.
public void setPageDisplay_Right(int value)
Sets the right coordinate of page display.
public int getPageDisplay_Top()
Gets the top coordinate of page display.
public void setPageDisplay_Top(int value)
Sets the top coordinate of page display.
public int getPageDisplay_Zoom()
Gets the zoom factor of page display.
public void setPageDisplay_Zoom(int value)
Sets the zoom factor of page display.
public int getPageNumber()
Gets the number of bookmark's destination page.
public void setPageNumber(int value)
Sets the number of bookmark's destination page.
public String getRemoteFile()
Gets the file (path) which is required for "GoToR" action of bookmark.
public void setRemoteFile(String value)
Sets the file (path) which is required for "GoToR" action of bookmark.
public String getTitle()
Gets bookmark's title.
public void setTitle(String value)
Sets bookmark's title.
public Color getTitleColor()
Gets the color of bookmark's title.
public void setTitleColor(Color value)
Sets the color of bookmark's title.
public boolean getOpen()
public void setOpen(boolean value)
Copyright © 2018 Aspose. All Rights Reserved.