Adobe InDesign CS4 (6.0) Object Model JS: GotoPageBehavior

InDesign CS4

Class

GotoPageBehavior

 A behavior object that jumps to a specific page of the document. Base Class: Behavior

QuickLinks

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Hierarchy

Button | FormField
Behavior
GotoPageBehavior

Properties

PropertyTypeAccessDescription
behaviorEventBehaviorEvents:
BehaviorEvents.MOUSE_UP
BehaviorEvents.MOUSE_DOWN
BehaviorEvents.MOUSE_ENTER
BehaviorEvents.MOUSE_EXIT
BehaviorEvents.ON_FOCUS
BehaviorEvents.ON_BLUR
r/wThe event which triggers the behavior.
enableBehaviorbool r/wIf true, the behavior is enabled.
idnumber readonlyThe unique ID of the GotoPageBehavior.
indexnumber readonlyThe index of the GotoPageBehavior within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring readonlyThe name of the GotoPageBehavior.
pageNumbernumber r/wThe page number to go to expressed as an index where 1 is the first page.
parentButton
FormField
readonlyThe parent of the GotoPageBehavior (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 GotoPageBehavior 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 GotoPageBehavior.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of GotoPageBehavior GotoPageBehaviors.itemByRange (from: any, to: any)

GotoPageBehavior GotoPageBehaviors.nextItem (obj: GotoPageBehavior)

GotoPageBehavior GotoPageBehaviors.previousItem (obj: GotoPageBehavior)

Return

Array of GotoPageBehavior GotoPageBehavior.getElements ()

GotoPageBehavior GotoPageBehaviors.[] (index: number)

GotoPageBehavior GotoPageBehaviors.add ([withProperties: Object])

GotoPageBehavior GotoPageBehaviors.anyItem ()

Array of GotoPageBehavior GotoPageBehaviors.everyItem ()

GotoPageBehavior GotoPageBehaviors.firstItem ()

GotoPageBehavior GotoPageBehaviors.item (index: any)

GotoPageBehavior GotoPageBehaviors.itemByID (id: number)

GotoPageBehavior GotoPageBehaviors.itemByName (name: string)

Array of GotoPageBehavior GotoPageBehaviors.itemByRange (from: any, to: any)

GotoPageBehavior GotoPageBehaviors.lastItem ()

GotoPageBehavior GotoPageBehaviors.middleItem ()

GotoPageBehavior GotoPageBehaviors.nextItem (obj: GotoPageBehavior)

GotoPageBehavior GotoPageBehaviors.previousItem (obj: GotoPageBehavior)

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