Adobe InDesign CS2 (4.0) Object Model JS: State

InDesign CS2

Class

State

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

QuickLinks

getElements, remove, toSource, toSpecifier

Hierarchy

Button
State
EPS | Graphic | GraphicLine | Group | Image | Oval | PDF | PICT | PageItem | Polygon | Rectangle | TextFrame | WMF

Properties

PropertyTypeAccessDescription
activebool r/wIf true, the state is active in the exported PDF.
enabledbool r/wIf true, the state is enabled in PDF documents.
epssEPSs readonlyA collection of EPS files.
graphicLinesGraphicLines readonlyA collection of graphic lines.
graphicsGraphics readonlyA collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
groupsGroups readonlyA collection of groups.
idnumber readonlyThe unique ID of the State.
imagesImages readonlyA collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
indexnumber readonlyThe index of the State within its containing object.
namestring readonlyThe name of the State.
ovalsOvals readonlyA collection of ellipses.
pageItemsPageItems readonlyThe 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.
parentButton readonlyThe parent of the State (a Button).
pdfsPDFs readonlyA collection of PDF files.
pictsPICTs readonlyA collection of PICT graphics.
polygonsPolygons readonlyA collection of polygons.
propertiesObject r/wA property that allows setting of several properties at the same time.
rectanglesRectangles readonlyA collection of rectangles.
statetypeStateTypes:
StateTypes.UP
StateTypes.ROLLOVER
StateTypes.DOWN
r/wThe type of user action that dictates the button's appearance.
textFramesTextFrames readonlyA collection of text frames.
wmfsWMFs readonlyA collection of WMF graphics.

Methods

Instances

Array of Object getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the State.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of State States.itemByRange (from: any, to: any)

State States.nextItem (obj: State)

State States.previousItem (obj: State)

Return

State States.add ([withProperties: Object])

State States.anyItem ()

Array of State States.everyItem ()

State States.firstItem ()

State States.item (index: any)

State States.itemByID (id: number)

State States.itemByName (name: string)

Array of State States.itemByRange (from: any, to: any)

State States.lastItem ()

State States.middleItem ()

State States.nextItem (obj: State)

State States.previousItem (obj: State)

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