MultiStateObjects

A collection of multi-state objects.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property	Type	Access	Description
length	Number	readonly	The number of objects in the collection.

Method Listing

MultiStateObject [] (index:Number)

Returns the MultiStateObject with the specified index.

Parameter	Type	Description
index	Number	The index.

MultiStateObject add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document Layer MasterSpread Page Spread PageItem, withProperties:Object)

Creates a new MultiStateObject

Parameter	Type	Description
layer	Layer	The layer on which to create the MultiStateObject. (Optional)
at	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location at which to insert the MultiStateObject relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
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. (Optional)
withProperties	Object	Initial values for properties of the new MultiStateObject (Optional)

MultiStateObject anyItem ()

Returns any MultiStateObject in the collection.

Number count ()

Displays the number of elements in the MultiStateObject.

MultiStateObject everyItem ()

Returns every MultiStateObject in the collection.

MultiStateObject firstItem ()

Returns the first MultiStateObject in the collection.

MultiStateObject item (index:Varies LongInteger String)

Returns the MultiStateObject with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

MultiStateObject itemByID (id:Number)

Returns the MultiStateObject with the specified ID.

Parameter	Type	Description
id	Number	The ID.

MultiStateObject itemByName (name:String)

Returns the MultiStateObject with the specified name.

Parameter	Type	Description
name	String	The name.

MultiStateObject itemByRange (from:Varies LongInteger MultiStateObject String, to:Varies LongInteger MultiStateObject String)

Returns the MultiStateObjects within the specified range.

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

Parameter

Type

Description

from

LongInteger

MultiStateObject

String

The MultiStateObject, index, or name at the beginning of the range. Can accept: MultiStateObject, Long Integer or String.

LongInteger

MultiStateObject

String

The MultiStateObject, index, or name at the end of the range. Can accept: MultiStateObject, Long Integer or String.

MultiStateObject lastItem ()

Returns the last MultiStateObject in the collection.

MultiStateObject middleItem ()

Returns the middle MultiStateObject in the collection.

MultiStateObject nextItem (obj:MultiStateObject)

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

Parameter	Type	Description
obj	MultiStateObject	The MultiStateObject whose index comes before the desired MultiStateObject.

MultiStateObject previousItem (obj:MultiStateObject)

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

Parameter	Type	Description
obj	MultiStateObject	The index of the MultiStateObject that follows the desired MultiStateObject.

String toSource ()

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

Object of

PlaceGun.multiStateObjects

Document.multiStateObjects

Layer.multiStateObjects

Spread.multiStateObjects

Page.multiStateObjects

MasterSpread.multiStateObjects

Oval.multiStateObjects

Rectangle.multiStateObjects

GraphicLine.multiStateObjects

Polygon.multiStateObjects

Group.multiStateObjects

SplineItem.multiStateObjects

Snippet.multiStateObjects

Cell.multiStateObjects

Table.multiStateObjects

Text.multiStateObjects

Character.multiStateObjects

Word.multiStateObjects

Line.multiStateObjects

TextColumn.multiStateObjects

Paragraph.multiStateObjects

TextStyleRange.multiStateObjects

InsertionPoint.multiStateObjects

TextFrame.multiStateObjects

Story.multiStateObjects

EndnoteTextFrame.multiStateObjects

XmlStory.multiStateObjects