K4 InDesign Javascript API Documentation

Interactive ElementsGotoAnchorBehavior

A behavior object that jumps to an anchor.

Extends

Instance Properties

Name Description Access
anchorItem The anchor item, specified as a bookmark or a hyperlink text or page destination. Can return: Bookmark, HyperlinkTextDestination or HyperlinkPageDestination. read-write
anchorName string The anchor name. read-only
behaviorEvent BehaviorEvents The event which triggers the behavior. read-write
enableBehavior bool If true, the behavior is enabled. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
filePath string The file path (colon delimited on the Mac OS). Can also accept: File. read-write
id number The unique ID of the GotoAnchorBehavior. read-only
index number The index of the GotoAnchorBehavior 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 GotoAnchorBehavior. read-only
parent The parent of the GotoAnchorBehavior (a Button, CheckBox, ComboBox, ListBox, RadioButton, TextBox or SignatureField). read-only
properties Object A property that allows setting of several properties at the same time. read-write
zoomSetting GoToZoomOptions The zoom setting. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
extractLabel(
key)
  → string
getElements(
)
  → GotoAnchorBehavior
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
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(
)
  → GotoAnchorBehavior
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.
remove(
)
Deletes the GotoAnchorBehavior.
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)
toSource(
)
  → string
Generates a string which, if executed, will return the GotoAnchorBehavior.
toSpecifier(
)
  → string
Retrieves the object specifier.