K4 InDesign Javascript API Documentation

Interactive ElementsMultiStateObjects

A collection of multi-state objects.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[layer] ​[, at], reference ​[, withProperties])
  → MultiStateObject
anyItem(
)
  → MultiStateObject
count(
)
  → number
everyItem(
)
  → MultiStateObject
firstItem(
)
  → MultiStateObject
item(
index)
  → MultiStateObject
itemByID(
id)
  → MultiStateObject
itemByName(
name)
  → MultiStateObject
itemByRange(
from, to)
  → MultiStateObject
lastItem(
)
  → MultiStateObject
middleItem(
)
  → MultiStateObject
nextItem(
obj)
  → MultiStateObject
previousItem(
obj)
  → MultiStateObject
toSource(
)
  → string
add(
[layer] ​[, at=LocationOptions.UNKNOWN], reference ​[, withProperties])
  → MultiStateObject
Creates a new MultiStateObject
layer Layer The layer on which to create the MultiStateObject. (Optional)
at LocationOptions The location at which to insert the MultiStateObject relative to the reference object or within the container object. (Optional)
reference 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)
anyItem(
)
  → MultiStateObject
Returns any MultiStateObject in the collection.
count(
)
  → number
Displays the number of elements in the MultiStateObject.
everyItem(
)
  → MultiStateObject
Returns every MultiStateObject in the collection.
firstItem(
)
  → MultiStateObject
Returns the first MultiStateObject in the collection.
item(
index)
  → MultiStateObject
Returns the MultiStateObject with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → MultiStateObject
Returns the MultiStateObject with the specified ID.
id number The ID.
itemByName(
name)
  → MultiStateObject
Returns the MultiStateObject with the specified name.
name string The name.
itemByRange(
from, to)
  → MultiStateObject
Returns the MultiStateObjects within the specified range.
from The MultiStateObject, index, or name at the beginning of the range. Can accept: MultiStateObject, Long Integer or String.
to The MultiStateObject, index, or name at the end of the range. Can accept: MultiStateObject, Long Integer or String.
lastItem(
)
  → MultiStateObject
Returns the last MultiStateObject in the collection.
middleItem(
)
  → MultiStateObject
Returns the middle MultiStateObject in the collection.
nextItem(
obj)
  → MultiStateObject
Returns the MultiStateObject whose index follows the specified MultiStateObject in the collection.
obj MultiStateObject The MultiStateObject whose index comes before the desired MultiStateObject.
previousItem(
obj)
  → MultiStateObject
Returns the MultiStateObject with the index previous to the specified index.
obj MultiStateObject The index of the MultiStateObject that follows the desired MultiStateObject.
toSource(
)
  → string
Generates a string which, if executed, will return the MultiStateObject.