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