com.aspose.pdf.facades

Class Bookmark



  • public final class Bookmark
    extends Object

    Represents a bookmark.

    • Constructor Detail

      • Bookmark

        public Bookmark()

        Initializes a new instance of the Bookmark class.

    • Method Detail

      • toOutlineItemCollection

        public OutlineItemCollection toOutlineItemCollection(IDocument doc)
        convert to OutlineItemCollection
        Parameters:
        doc - Document object
        Returns:
        OutlineItemCollection object
      • getAction

        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".

        Returns:
        String value
      • setAction

        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".

        Parameters:
        value - String value
      • getBoldFlag

        public boolean getBoldFlag()

        Gets the bold flag of bookmark's title.

        Returns:
        boolean value
      • setBoldFlag

        public void setBoldFlag(boolean value)

        Sets the bold flag of bookmark's title.

        Parameters:
        value - boolean value
      • getChildItem

        @Deprecated
        public Bookmarks getChildItem()
        Deprecated. 

        Gets bookmark's children.

        Obsolete("Use getChildItems() property instead of this one.")
        Returns:
        Bookmarks element
      • setChildItem

        @Deprecated
        public void setChildItem(Bookmarks value)
        Deprecated. 

        Sets bookmark's children.

        Obsolete("Use setChildItems() property instead of this one.")
        Parameters:
        value - Bookmarks element
      • getChildItems

        public Bookmarks getChildItems()

        Gets bookmark's children.

        Returns:
        bookmark's children items.
      • setChildItems

        public void setChildItems(Bookmarks value)

        Sets bookmark's children.

        Parameters:
        value - bookmark's children items.
      • getCustomAcorbatViewerMenuActionName

        public int[] getCustomAcorbatViewerMenuActionName()

        The action name corresponding to execute a menu item in Acrobat viewer.

        Returns:
        array of int value
      • setCustomAcorbatViewerMenuActionName

        public void setCustomAcorbatViewerMenuActionName(int[] value)

        Sets the action name corresponding to execute a menu item in Acrobat viewer.

        Parameters:
        value - array of int value
      • getDestination

        public String getDestination()

        Gets bookmark's destination page. Required if action is set as "".

        Returns:
        String value
      • setDestination

        public void setDestination(String value)

        Sets bookmark's destination page. Required if action is set as "".

        Parameters:
        value - String value
      • getItalicFlag

        public boolean getItalicFlag()

        Gets the italic flag of bookmark's title.

        Returns:
        boolean value
      • setItalicFlag

        public void setItalicFlag(boolean value)

        Sets the italic flag of bookmark's title.

        Parameters:
        value - boolean value
      • getLevel

        public int getLevel()

        Gets bookmark's hierarchy level.

        Returns:
        int value
      • setLevel

        public void setLevel(int value)

        Sets bookmark's hierarchy level.

        Parameters:
        value - int value
      • getPageDisplay

        public String getPageDisplay()

        Gets the type of display bookmark's destination page.

        Returns:
        String value
      • setPageDisplay

        public void setPageDisplay(String value)

        Sets the type of display bookmark's destination page.

        Parameters:
        value - String value
      • getPageDisplay_Bottom

        public int getPageDisplay_Bottom()

        Gets the bottom coordinate of page display.

        Returns:
        int value
      • setPageDisplay_Bottom

        public void setPageDisplay_Bottom(int value)

        Sets the bottom coordinate of page display.

        Parameters:
        value - int value
      • getPageDisplay_Left

        public int getPageDisplay_Left()

        Gets the left coordinate of page display.

        Returns:
        int value
      • setPageDisplay_Left

        public void setPageDisplay_Left(int value)

        Sets the left coordinate of page display.

        Parameters:
        value - int value
      • getPageDisplay_Right

        public int getPageDisplay_Right()

        Gets the right coordinate of page display.

        Returns:
        int value
      • setPageDisplay_Right

        public void setPageDisplay_Right(int value)

        Sets the right coordinate of page display.

        Parameters:
        value - int value
      • getPageDisplay_Top

        public int getPageDisplay_Top()

        Gets the top coordinate of page display.

        Returns:
        int value
      • setPageDisplay_Top

        public void setPageDisplay_Top(int value)

        Sets the top coordinate of page display.

        Parameters:
        value - int value
      • getPageDisplay_Zoom

        public int getPageDisplay_Zoom()

        Gets the zoom factor of page display.

        Returns:
        int value
      • setPageDisplay_Zoom

        public void setPageDisplay_Zoom(int value)

        Sets the zoom factor of page display.

        Parameters:
        value - int value
      • getPageNumber

        public int getPageNumber()

        Gets the number of bookmark's destination page.

        Returns:
        int value
      • setPageNumber

        public void setPageNumber(int value)

        Sets the number of bookmark's destination page.

        Parameters:
        value - int value
      • getRemoteFile

        public String getRemoteFile()

        Gets the file (path) which is required for "GoToR" action of bookmark.

        Returns:
        String value
      • setRemoteFile

        public void setRemoteFile(String value)

        Sets the file (path) which is required for "GoToR" action of bookmark.

        Parameters:
        value - String value
      • getTitle

        public String getTitle()

        Gets bookmark's title.

        Returns:
        String value
      • setTitle

        public void setTitle(String value)

        Sets bookmark's title.

        Parameters:
        value - String value
      • getTitleColor

        public Color getTitleColor()

        Gets the color of bookmark's title.

        Returns:
        Color element
      • setTitleColor

        public void setTitleColor(Color value)

        Sets the color of bookmark's title.

        Parameters:
        value - Color element
      • isOpen

        public boolean isOpen()

        Gets bookmark state (open, close).

        Returns:
        boolean value
      • setOpen

        public void setOpen(boolean value)

        Sets bookmark state (open, close).

        Parameters:
        value - boolean value