Bookmark
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| bookmarks | Bookmarks | readonly | A collection of bookmarks. |
| destination | HyperlinkExternalPageDestinationHyperlinkPageDestination HyperlinkTextDestination Page |
readonly | The destination that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or Page. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| id | number | readonly | The unique ID of the Bookmark. |
| indent | number | readonly | The indent level of the bookmark. |
| index | number | readonly | The index of the Bookmark within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the Bookmark. |
| parent | Bookmark Document |
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
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
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=LocationOptions.AT_END][, reference:
varies])
Moves the bookmark to the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | The bookmark location relative to the reference object or within the containing object. (Optional) (default: LocationOptions.AT_END) |
| reference | Bookmark Bookmark Document | 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.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
void showBookmark ()
Go to the bookmark.
string toSource ()
Generates a string which, if executed, will return the Bookmark.
Element of
Bookmark.parent
GotoAnchorBehavior.anchorItem
Used in:
Bookmark Bookmarks.nextItem (obj: Bookmark)
Bookmark Bookmarks.previousItem (obj: Bookmark)
Return
Array of Bookmark Bookmark.getElements ()
Bookmark Bookmark.move ([to: LocationOptions=LocationOptions.AT_END][, reference: varies])
Bookmark Bookmarks.[] (index: number)
Bookmark Bookmarks.add (destination: varies[, withProperties: Object])
Bookmark Bookmarks.anyItem ()
Array of Bookmark Bookmarks.everyItem ()
Bookmark Bookmarks.firstItem ()
Bookmark Bookmarks.item (index: varies)
Bookmark Bookmarks.itemByID (id: number)
Bookmark Bookmarks.itemByName (name: string)
Array of Bookmark Bookmarks.itemByRange (from: varies, to: varies)
Bookmark Bookmarks.lastItem ()
Bookmark Bookmarks.middleItem ()
Bookmark Bookmarks.nextItem (obj: Bookmark)
Bookmark Bookmarks.previousItem (obj: Bookmark)
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |