Class CoreControls.Bookmark
Represents a bookmark in a Document.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
CoreControls.Bookmark(children, name, pageNumber, The, verticalOffset, horizontalOffset, url)
Bookmarks typically represent an outline of the document, and as each bookmark is usually associated with a specific page in a document, they are typically used to facilitate navigation.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Gets the children of the bookmark.
|
|
|
getHPos()
Gets the horizontal position of the bookmark.
|
|
|
getName()
Gets the name of the bookmark.
|
|
|
Gets the page number of the bookmark.
|
|
|
Gets the parent of this bookmark if it has one.
|
|
|
getURL()
Gets the url of the bookmark if it has one.
|
|
|
getVPos()
Gets the vertical position of the bookmark.
|
|
|
isValid()
Determines whether the bookmark goes to a valid destination.
|
Class Detail
CoreControls.Bookmark(children, name, pageNumber, The, verticalOffset, horizontalOffset, url)
Bookmarks typically represent an outline of the document, and as each bookmark is usually associated with a specific page in a document, they are typically used to facilitate navigation.
- Parameters:
- {array} children
- A list of child bookmarks
- {string} name
- The name of the bookmark
- {number} pageNumber
- The page number of the bookmark
- {CoreControls.Bookmark} The
- parent bookmark of this bookmark
- {number} verticalOffset
- The vertical position that the linked page will be scrolled to
- {number} horizontalOffset
- The horizontal position that the linked page will be scrolled to
- {string} url Optional
- An optional parameter that allows the bookmark to link to a URL instead of a page number (this overrides the page number)
Method Detail
{array}
getChildren()
Gets the children of the bookmark.
- Returns:
- {array} The children of the bookmark
{number}
getHPos()
Gets the horizontal position of the bookmark.
- Returns:
- {number} The horizontal position of the bookmark
{string}
getName()
Gets the name of the bookmark.
- Returns:
- {string} The name of the bookmark
{integer}
getPageNumber()
Gets the page number of the bookmark.
- Returns:
- {integer} The page number of the bookmark
{CoreControls.Bookmark}
getParent()
Gets the parent of this bookmark if it has one.
- Returns:
- {CoreControls.Bookmark} The parent of the bookmark
{string}
getURL()
Gets the url of the bookmark if it has one.
- Returns:
- {string} The url of the bookmark
{number}
getVPos()
Gets the vertical position of the bookmark.
- Returns:
- {number} The vertical position of the bookmark
isValid()
Determines whether the bookmark goes to a valid destination.
return {boolean} Whether the bookmark points to a valid destination