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 |
|---|---|
|
GetHPos()
Gets the horizontal position of the bookmark.
|
|
|
GetName()
Gets the name of the bookmark.
|
|
|
Gets the page number of the bookmark.
|
|
|
GetURL()
Gets the url of the bookmark if it has one.
|
|
|
GetVPos()
Gets the vertical position of the bookmark.
|
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
GetHPos()
Gets the horizontal position of the bookmark.
- Returns:
- The horizontal position of the bookmark.
GetName()
Gets the name of the bookmark.
- Returns:
- The name of the bookmark.
GetPageNumber()
Gets the page number of the bookmark.
- Returns:
- The page number of the bookmark.
GetURL()
Gets the url of the bookmark if it has one.
- Returns:
- The url of the bookmark if it has one.
GetVPos()
Gets the vertical position of the bookmark.
- Returns:
- The vertical position of the bookmark.