MultiStateObjects
See also MultiStateObject.
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
MultiStateObject [] (index:
number)
Returns the MultiStateObject with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
MultiStateObject add ([layer:
Layer][, at:
LocationOptions=LocationOptions.UNKNOWN][, reference:
varies][, withProperties:
Object])
Creates a new MultiStateObject
| Parameter | Type | Description |
|---|---|---|
| layer | Layer | The layer on which to create the MultiStateObject. (Optional) |
| at | LocationOptions: 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) |
| reference | Document 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) |
| 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.
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.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer 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. |
Array of MultiStateObject itemByRange (from:
varies, to:
varies)
Returns the MultiStateObjects within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer MultiStateObject String | The MultiStateObject, index, or name at the beginning of the range. Can accept: MultiStateObject, Long Integer or String. |
| to | Long 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.
| 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.
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.3i | Contents :: Index |