K4 InDesign Javascript API Documentation

HyperlinksBookmark

A bookmark.

Instance Properties

Name Description Access
bookmarks Bookmarks A collection of bookmarks. read-only
destination The destination that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination or Page. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the Bookmark. read-only
indent number The indent level of the bookmark. read-only
index number The index of the Bookmark within its containing object. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
name string The name of the Bookmark. read-write
parent The parent of the Bookmark (a Document or Bookmark). read-only
properties Object A property that allows setting of several properties at the same time. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → Bookmark
insertLabel(
key, value)
move(
[to], reference)
  → Bookmark
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
showBookmark(
)
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → Bookmark
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
move(
[to=LocationOptions.AT_END], reference)
  → Bookmark
Moves the bookmark to the specified location.
to LocationOptions The bookmark location relative to the reference object or within the containing object. (Optional)
reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Bookmark, Document or Bookmark. (Optional)
remove(
)
Deletes the Bookmark.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
showBookmark(
)
Go to the bookmark.
toSource(
)
  → string
Generates a string which, if executed, will return the Bookmark.
toSpecifier(
)
  → string
Retrieves the object specifier.