InDesign2026
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 21.5.1.73
Collection of MultiStateObject

MultiStateObjects

A collection of multi-state objects.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

→ MultiStateObject

Returns the MultiStateObject with the specified index.

index Number The index.
→ MultiStateObject

Creates a new MultiStateObject

layer? Layer The layer on which to create the MultiStateObject.
at? LocationOptions The location at which to insert the MultiStateObject relative to the reference object or within the container object.
reference? Document | Layer | MasterSpread | Page | Spread | PageItem The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem.
withProperties? Object Initial values for properties of the new MultiStateObject
→ Number

Displays the number of elements in the MultiStateObject.

→ MultiStateObject[]

Returns every MultiStateObject in the collection.

→ MultiStateObject

Returns the first MultiStateObject in the collection.

→ MultiStateObject

Returns the MultiStateObject with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
→ MultiStateObject

Returns the MultiStateObject with the specified name.

name String The name.
→ MultiStateObject[]

Returns the MultiStateObjects within the specified range.

from LongInteger | MultiStateObject | String The MultiStateObject, index, or name at the beginning of the range. Can accept: MultiStateObject, Long Integer or String.
to LongInteger | MultiStateObject | String The MultiStateObject, index, or name at the end of the range. Can accept: MultiStateObject, Long Integer or String.
→ MultiStateObject

Returns the last MultiStateObject in the collection.

→ MultiStateObject

Returns the middle MultiStateObject in the collection.

→ MultiStateObject

Returns the MultiStateObject whose index follows the specified MultiStateObject in the collection.

obj MultiStateObject The MultiStateObject whose index comes before the desired MultiStateObject.
→ MultiStateObject

Returns the MultiStateObject with the index previous to the specified index.

obj MultiStateObject The index of the MultiStateObject that follows the desired MultiStateObject.
→ String

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

Object of 28

Properties elsewhere that hold a MultiStateObjects.

Cell.multiStateObjectsCharacter.multiStateObjectsDocument.multiStateObjectsEndnoteTextFrame.multiStateObjectsFlexObject.multiStateObjectsGraphicLine.multiStateObjectsGroup.multiStateObjectsInsertionPoint.multiStateObjectsLayer.multiStateObjectsLine.multiStateObjectsMasterSpread.multiStateObjectsOval.multiStateObjectsPage.multiStateObjectsParagraph.multiStateObjectsPlaceGun.multiStateObjectsPolygon.multiStateObjectsRectangle.multiStateObjectsSnippet.multiStateObjectsSplineItem.multiStateObjectsSpread.multiStateObjectsStory.multiStateObjectsTable.multiStateObjectsText.multiStateObjectsTextColumn.multiStateObjectsTextFrame.multiStateObjectsTextStyleRange.multiStateObjectsWord.multiStateObjectsXmlStory.multiStateObjects