InDesign Server2025
API 20.5.0.49
Object

State

A state (states define the display of the field in an exported PDF).

Properties

NameType AccessDescription
Boolean read/write If true, the state is active in the exported PDF.
Boolean read/write If true, the state is enabled in PDF documents.
EndnoteTextFrames<EndnoteTextFrame> readonly A collection of endnote text frames.
EPSs<EPS> readonly A collection of EPS files.
EPSTexts<EPSText> readonly EPSTexts
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
GraphicLines<GraphicLine> readonly A collection of graphic lines.
Graphics<Graphic> readonly A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
Groups<Group> readonly A collection of groups.
Number readonly The unique ID of the State.
Images<Image> readonly A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
Number readonly The index of the State within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write The name of the State.
Ovals<Oval> readonly A collection of ellipses.
PageItems<PageItem> readonly The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
CheckBox | MultiStateObject | Button | RadioButton readonly The parent of the State (a Button, MultiStateObject, CheckBox or RadioButton).
PDFs<PDF> readonly A collection of PDF files.
PICTs<PICT> readonly A collection of PICT graphics.
Polygons<Polygon> readonly A collection of polygons.
Object read/write A property that allows setting of several properties at the same time.
Rectangles<Rectangle> readonly A collection of rectangles.
SplineItems<SplineItem> readonly The spline items collection.
StateTypes | LongInteger
read/write For a button, the type of user action that dictates the object's appearance. For a MultiStateObject, which has no user actions associated with states, this property is a numeric value uniquely identifying the state. Can return: StateTypes enumerator or Long Integer.
SVGs<SVG> readonly A collection of SVG files.
TextFrames<TextFrame> readonly A collection of text frames.
WMFs<WMF> readonly A collection of WMF graphics.

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.
void

Adds page items to this state.

pageitems PageItem[] One or more page items to add to this state.
State[]

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

void

Moves the state to a new position in its parent collection.

newPosition Number the index to move the state to in its parent collection
void

Releases this state's appearance as a page item, removing the state from its parent object.

void

Deletes the State.

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 State.

String

Retrieves the object specifier.

Object of 20

Properties elsewhere that hold a State.

Parameter of 3

Method parameters that accept a State.

Return 14

Methods that return a State.