A collection of bookmarks.
Methods
Bookmarkadd (destination:
any[, withProperties:
Object])
Creates a new bookmark.
| Parameter | Type | Description |
|---|---|---|
| destination | HyperlinkTextDestination HyperlinkPageDestination HyperlinkExternalPageDestination Page |
The bookmark destination. For information, see hyperlink page destination, hyperlink external page destination, hyperlink text destination, or hyperlink url destination. Can accept: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or Page. |
| withProperties | Object | Initial values for properties of the new Bookmark (Optional) |
BookmarkanyItem ()
Returns any Bookmark in the collection.
number count ()
Displays the number of elements in the Bookmark.
Array of BookmarkeveryItem ()
Returns every Bookmark in the collection.
BookmarkfirstItem ()
Returns the first Bookmark in the collection.
Bookmarkitem (index:
any)
Returns the Bookmark with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
BookmarkitemByID (id:
number)
Returns the Bookmark with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
BookmarkitemByName (name:
string)
Returns the Bookmark with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of BookmarkitemByRange (from:
any, to:
any)
Returns the Bookmarks within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Bookmark Long Integer String |
The Bookmark, index, or name at the beginning of the range. Can accept: Bookmark, Long Integer or String. |
| to | Bookmark Long Integer String |
The Bookmark, index, or name at the end of the range. Can accept: Bookmark, Long Integer or String. |
BookmarklastItem ()
Returns the last Bookmark in the collection.
BookmarkmiddleItem ()
Returns the middle Bookmark in the collection.
BookmarknextItem (obj:
Bookmark)
Returns the Bookmark whose index follows the specified Bookmark in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Bookmark | The Bookmark whose index comes before the desired Bookmark. |
BookmarkpreviousItem (obj:
Bookmark)
Returns the Bookmark with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Bookmark | The index of the Bookmark that follows the desired Bookmark. |
string toSource ()
Generates a string which, if executed, will return the Bookmark.