Adobe InCopy CS6 (8.0) Object Model JS: GotoPageBehavior

previous page next page

Class

GotoPageBehavior

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

GotoPageBehavior

Property	Type	Access	Description
behaviorEvent	BehaviorEvents: BehaviorEvents.MOUSE_UP BehaviorEvents.MOUSE_DOWN BehaviorEvents.MOUSE_ENTER BehaviorEvents.MOUSE_EXIT BehaviorEvents.ON_FOCUS BehaviorEvents.ON_BLUR	readonly	The event which triggers the behavior.
enableBehavior	bool	readonly	If true, the behavior is enabled.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	number	readonly	The unique ID of the GotoPageBehavior.
index	number	readonly	The index of the GotoPageBehavior within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
name	string	readonly	The name of the GotoPageBehavior.
pageNumber	number	readonly	The page number to go to expressed as an index where 1 is the first page.
parent	Button	readonly	The parent of the GotoPageBehavior (a Button).
properties	Object	r/w	A property that allows setting of several properties at the same time.
zoomSetting	GoToZoomOptions: GoToZoomOptions.INHERIT_ZOOM GoToZoomOptions.FIT_WINDOW GoToZoomOptions.FIT_WIDTH GoToZoomOptions.FIT_VISIBLE GoToZoomOptions.ACTUAL_SIZE	readonly	The zoom setting.

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

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

Parameter	Type	Description
key	string	The 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.

Parameter	Type	Description
key	string	The key.
value	string	The value.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)