Adobe InDesign CS2 (4.0) Object Model JS: GotoAnchorBehavior

InDesign CS2

Class

GotoAnchorBehavior

 A behavior object that jumps to an anchor. Base Class: Behavior

QuickLinks

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Hierarchy

Button | FormField
Behavior
GotoAnchorBehavior

Properties

PropertyTypeAccessDescription
anchorItemHyperlink r/wThe anchor item, specified as a hyperlink.
anchorNamestring readonlyThe anchor name.
enableBehaviorbool r/wIf true, the behavior is enabled.
eventBehaviorEvents:
BehaviorEvents.MOUSE_UP
BehaviorEvents.MOUSE_DOWN
BehaviorEvents.MOUSE_ENTER
BehaviorEvents.MOUSE_EXIT
BehaviorEvents.ON_FOCUS
BehaviorEvents.ON_BLUR
r/wThe event that triggers the behavior.
filePathFile r/wThe full path to the file.
idnumber readonlyThe unique ID of the GotoAnchorBehavior.
indexnumber readonlyThe index of the GotoAnchorBehavior within its containing object.
labelstring r/wA property that can be set to any string.
namestring readonlyThe name of the GotoAnchorBehavior.
parentButton
FormField
readonlyThe parent of the GotoAnchorBehavior (a FormField or Button).
propertiesObject r/wA property that allows setting of several properties at the same time.
zoomSettingGoToZoomOptions:
GoToZoomOptions.INHERIT_ZOOM
GoToZoomOptions.FIT_WINDOW
GoToZoomOptions.FIT_WIDTH
GoToZoomOptions.FIT_VISIBLE
GoToZoomOptions.ACTUAL_SIZE
r/wThe zoom setting.

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.

void remove ()
Deletes the GotoAnchorBehavior.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of GotoAnchorBehavior GotoAnchorBehaviors.itemByRange (from: any, to: any)

GotoAnchorBehavior GotoAnchorBehaviors.nextItem (obj: GotoAnchorBehavior)

GotoAnchorBehavior GotoAnchorBehaviors.previousItem (obj: GotoAnchorBehavior)

Return

GotoAnchorBehavior GotoAnchorBehaviors.add ([withProperties: Object])

GotoAnchorBehavior GotoAnchorBehaviors.anyItem ()

Array of GotoAnchorBehavior GotoAnchorBehaviors.everyItem ()

GotoAnchorBehavior GotoAnchorBehaviors.firstItem ()

GotoAnchorBehavior GotoAnchorBehaviors.item (index: any)

GotoAnchorBehavior GotoAnchorBehaviors.itemByID (id: number)

GotoAnchorBehavior GotoAnchorBehaviors.itemByName (name: string)

Array of GotoAnchorBehavior GotoAnchorBehaviors.itemByRange (from: any, to: any)

GotoAnchorBehavior GotoAnchorBehaviors.lastItem ()

GotoAnchorBehavior GotoAnchorBehaviors.middleItem ()

GotoAnchorBehavior GotoAnchorBehaviors.nextItem (obj: GotoAnchorBehavior)

GotoAnchorBehavior GotoAnchorBehaviors.previousItem (obj: GotoAnchorBehavior)

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