Adobe InDesign CS2 (4.0) Object Model JS: Bookmark

InDesign CS2

Class

Bookmark

 A bookmark.

QuickLinks

extractLabel, getElements, insertLabel, move, remove, showBookmark, toSource, toSpecifier

Hierarchy

Bookmark | Document
Bookmark
Bookmark

Properties

PropertyTypeAccessDescription
bookmarksBookmarks readonlyA collection of bookmarks.
destinationHyperlinkExternalPageDestinationHyperlinkPageDestination
HyperlinkTextDestination
Page
readonlyThe destination that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or Page.
idnumber readonlyThe unique ID of the Bookmark.
indentnumber readonlyThe indent level of the bookmark.
indexnumber readonlyThe index of the Bookmark within its containing object.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the Bookmark.
parentBookmark
Document
readonlyThe parent of the Bookmark (a Document or Bookmark).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Object 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

Bookmark move ([to: LocationOptions=LocationOptions.AT_END][, reference: any])
Moves the bookmark to the specified location.

ParameterTypeDescription
toLocationOptions:
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)
referenceBookmark
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.

void showBookmark ()
Go to the bookmark.

string toSource ()
Generates a string which, if executed, will return the Bookmark.

string toSpecifier ()
Retrieves the object specifier.

Element of

Bookmark.parent

Used in:

Bookmark Bookmark.move ([to: LocationOptions=LocationOptions.AT_END][, reference: any])

array of Bookmark Bookmarks.itemByRange (from: any, to: any)

Bookmark Bookmarks.nextItem (obj: Bookmark)

Bookmark Bookmarks.previousItem (obj: Bookmark)

Return

Bookmark Bookmark.move ([to: LocationOptions=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)

Jongware, 27-Jun-2010 v3.0.3dContents :: Index