InDesign2026
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 21.5.1.73
Object

GotoStateBehavior

A goto state behavior.

Behavior ›GotoStateBehavior
Hierarchy

Button

GotoStateBehavior

Properties

NameType AccessDescription
MultiStateObject read/write The associated multi-state object page item.
BehaviorEvents
 read/write The event which triggers the behavior.
Boolean read/write If true, the behavior is enabled.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean read/write If true, will automatically go back to the prior state on roll off of the rollover event.
Number readonly The unique ID of the GotoStateBehavior.
Number readonly The index of the GotoStateBehavior within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String readonly The name of the GotoStateBehavior.
Button readonly The parent of the GotoStateBehavior (a Button).
Object read/write A property that allows setting of several properties at the same time.
String read/write The name of the state in the associated multi-state object.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

Gets the label value associated with the specified key.

key String The key.
→ GotoStateBehavior[]

Resolves the object specifier, creating an array of object references.

→ void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
→ void

Deletes the GotoStateBehavior.

→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

Generates a string which, if executed, will return the GotoStateBehavior.

→ String

Retrieves the object specifier.

Object of 3

Properties elsewhere that hold a GotoStateBehavior.

Event.parentEventListener.parentMutationEvent.parent

Parameter of 3

Method parameters that accept a GotoStateBehavior.

GotoStateBehaviors.itemByRange(from)GotoStateBehaviors.nextItem(obj)GotoStateBehaviors.previousItem(obj)

Return 14

Methods that return a GotoStateBehavior.

GotoStateBehavior.getElements()GotoStateBehaviors.[]()GotoStateBehaviors.add()GotoStateBehaviors.anyItem()GotoStateBehaviors.everyItem()GotoStateBehaviors.firstItem()GotoStateBehaviors.item()GotoStateBehaviors.itemByID()GotoStateBehaviors.itemByName()GotoStateBehaviors.itemByRange()GotoStateBehaviors.lastItem()GotoStateBehaviors.middleItem()GotoStateBehaviors.nextItem()GotoStateBehaviors.previousItem()