A bookmark.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| bookmarks | Bookmarks | readonly | A collection of bookmarks. |
| destination | any | readonly | The destination that the hyperlink points to. For information, see hyperlink page destination, hyperlink external page destination, hyperlink text destination, or hyperlink url destination. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or Page. |
| id | number | readonly | The unique ID of the Bookmark. |
| indent | number | readonly | The indent level of the bookmark in the Bookmarks palette. |
| index | number | readonly | The index of the Bookmark within its containing object. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the Bookmark. |
| parent | any | readonly | The parent of the Bookmark (a Document or Bookmark). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
Methods
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of Bookmark
getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
Bookmark
move ([to:
LocationOptions=AT_END][, reference:
any])
Moves the bookmark to the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions
: BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The bookmark location relative to the reference object or within the containing object. (Optional) (default: AT_END) |
| reference |
Bookmark
Document Bookmark |
The reference object. Note: Required when the to parameter specifies before or after. Can accept: Bookmark, Document or Bookmark. (Optional) |
void remove ()
Deletes the Bookmark.
void showBookmark ()
Go to the bookmark
string toSource ()
Generates a string which, if executed, will return the Bookmark.
string toSpecifier ()
Retrieves the object specifier.
Used in:
Bookmarks.previousItem ( obj: Bookmark)Bookmarks.nextItem ( obj: Bookmark)
Returned by:
Array of Bookmark Bookmark.getElements ( )Bookmark Bookmark.move ( [to: LocationOptions=AT_END][, reference: any] )
Bookmark Bookmarks.add ( destination: any[, withProperties: Object] )
Bookmark Bookmarks.anyItem ( )
Array of Bookmark Bookmarks.everyItem ( )
Bookmark Bookmarks.firstItem ( )
Bookmark Bookmarks.item ( index: any )
Bookmark Bookmarks.itemByID ( id: number )
Bookmark Bookmarks.itemByName ( name: string )
Array of Bookmark Bookmarks.itemByRange ( from: any, to: any )
Bookmark Bookmarks.lastItem ( )
Bookmark Bookmarks.middleItem ( )
Bookmark Bookmarks.nextItem ( obj: Bookmark )
Bookmark Bookmarks.previousItem ( obj: Bookmark )