Class

MultiStateObjects

 A collection of multi-state objects.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

MultiStateObject [] (index: number)
Returns the MultiStateObject with the specified index.

ParameterTypeDescription
indexnumberThe index.

MultiStateObject add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new MultiStateObject

ParameterTypeDescription
layerLayerThe layer on which to create the MultiStateObject. (Optional)
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location at which to insert the MultiStateObject relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
referenceDocument
Layer
MasterSpread
Page
PageItem
Spread
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withPropertiesObjectInitial 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.

Array of MultiStateObject everyItem ()
Returns every MultiStateObject in the collection.

MultiStateObject firstItem ()
Returns the first MultiStateObject in the collection.

MultiStateObject item (index: varies)
Returns the MultiStateObject with the specified index or name.

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

MultiStateObject itemByID (id: number)
Returns the MultiStateObject with the specified ID.

ParameterTypeDescription
idnumberThe ID.

MultiStateObject itemByName (name: string)
Returns the MultiStateObject with the specified name.

ParameterTypeDescription
namestringThe name.

Array of MultiStateObject itemByRange (from: varies, to: varies)
Returns the MultiStateObjects within the specified range.

ParameterTypeDescription
fromLong Integer
MultiStateObject
String
The MultiStateObject, index, or name at the beginning of the range. Can accept: MultiStateObject, Long Integer or String.
toLong Integer
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.

ParameterTypeDescription
objMultiStateObjectThe MultiStateObject whose index comes before the desired MultiStateObject.

MultiStateObject previousItem (obj: MultiStateObject)
Returns the MultiStateObject with the index previous to the specified index.

ParameterTypeDescription
objMultiStateObjectThe index of the MultiStateObject that follows the desired MultiStateObject.

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

Element of

Cell.multiStateObjects

Character.multiStateObjects

Document.multiStateObjects

GraphicLine.multiStateObjects

Group.multiStateObjects

InsertionPoint.multiStateObjects

Layer.multiStateObjects

Line.multiStateObjects

MasterSpread.multiStateObjects

Oval.multiStateObjects

Page.multiStateObjects

Paragraph.multiStateObjects

PlaceGun.multiStateObjects

Polygon.multiStateObjects

Rectangle.multiStateObjects

Snippet.multiStateObjects

SplineItem.multiStateObjects

Spread.multiStateObjects

Story.multiStateObjects

Table.multiStateObjects

Text.multiStateObjects

TextColumn.multiStateObjects

TextFrame.multiStateObjects

TextStyleRange.multiStateObjects

Word.multiStateObjects

XmlStory.multiStateObjects

Jongware, 28-Apr-2012 v3.0.3hContents :: Index