Bookmark
Overview
Bookmark is a class in Aspose.Pdf FOSS for Java.
Represents a bookmark (outline item) in a PDF document.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
title | String | Read | Returns the title of this bookmark. |
pageNumber | int | Read | Returns the 1-based page number this bookmark points to. |
action | String | Read | Returns the action string associated with this bookmark. |
childItems | List<Bookmark> | Read | Returns the child bookmarks. |
level | int | Read | Returns the nesting level of this bookmark. |
destination | ExplicitDestination | Read | Returns the destination associated with this bookmark. |
pageDisplay | ExplicitDestination | Read | Returns the page display destination for this bookmark. |
pageDisplay_Zoom | double | Read | Returns the zoom factor from the XYZ destination, or 0 if not set. |
Methods
| Signature | Description |
|---|---|
Bookmark() | Creates a new empty bookmark. |
getTitle() → String | Returns the title of this bookmark. |
setTitle(title: String) | Sets the title of this bookmark. |
getPageNumber() → int | Returns the 1-based page number this bookmark points to. |
setPageNumber(pageNumber: int) | Sets the 1-based page number this bookmark points to. |
getAction() → String | Returns the action string associated with this bookmark. |
setAction(action: String) | Sets the action string associated with this bookmark. |
getChildItems() → List<Bookmark> | Returns the child bookmarks. |
setChildItems(childItems: List<Bookmark>) | Sets the child bookmarks. |
getLevel() → int | Returns the nesting level of this bookmark. |
setLevel(level: int) | Sets the nesting level of this bookmark. |
getDestination() → ExplicitDestination | Returns the destination associated with this bookmark. |
setDestination(destination: ExplicitDestination) | Sets the destination for this bookmark. |
setPageDisplay(dest: ExplicitDestination) | Sets the page display destination for this bookmark. |
getPageDisplay() → ExplicitDestination | Returns the page display destination for this bookmark. |
getPageDisplay_Zoom() → double | Returns the zoom factor from the XYZ destination, or 0 if not set. |
setPageDisplay_Zoom(zoom: double) | Sets the zoom factor for the page display. |
toString() → String |