HyperlinksBookmarks

A collection of bookmarks.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
destination ​[, withProperties])
 → Bookmark
anyItem(
)
 → Bookmark
count(
)
 → number
everyItem(
)
 → Bookmark
firstItem(
)
 → Bookmark
item(
index)
 → Bookmark
itemByID(
id)
 → Bookmark
itemByName(
name)
 → Bookmark
itemByRange(
from, to)
 → Bookmark
lastItem(
)
 → Bookmark
middleItem(
)
 → Bookmark
nextItem(
obj)
 → Bookmark
previousItem(
obj)
 → Bookmark
toSource(
)
 → string
add(
destination ​[, withProperties])
 → Bookmark
Creates a new bookmark.
destination The bookmark destination. Can accept: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or Page.
withProperties Object Initial values for properties of the new Bookmark (Optional)
anyItem(
)
 → Bookmark
Returns any Bookmark in the collection.
count(
)
 → number
Displays the number of elements in the Bookmark.
everyItem(
)
 → Bookmark
Returns every Bookmark in the collection.
firstItem(
)
 → Bookmark
Returns the first Bookmark in the collection.
item(
index)
 → Bookmark
Returns the Bookmark with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
 → Bookmark
Returns the Bookmark with the specified ID.
id number The ID.
itemByName(
name)
 → Bookmark
Returns the Bookmark with the specified name.
name string The name.
itemByRange(
from, to)
 → Bookmark
Returns the Bookmarks within the specified range.
from The Bookmark, index, or name at the beginning of the range. Can accept: Bookmark, Long Integer or String.
to The Bookmark, index, or name at the end of the range. Can accept: Bookmark, Long Integer or String.
lastItem(
)
 → Bookmark
Returns the last Bookmark in the collection.
middleItem(
)
 → Bookmark
Returns the middle Bookmark in the collection.
nextItem(
obj)
 → Bookmark
Returns the Bookmark whose index follows the specified Bookmark in the collection.
obj Bookmark The Bookmark whose index comes before the desired Bookmark.
previousItem(
obj)
 → Bookmark
Returns the Bookmark with the index previous to the specified index.
obj Bookmark The index of the Bookmark that follows the desired Bookmark.
toSource(
)
 → string
Generates a string which, if executed, will return the Bookmark.