K4 InDesign Javascript API Documentation

Interactive ElementsGotoStateBehaviors

A collection of goto state behaviors.

Instance Properties

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

Methods

add(
[withProperties])
  → GotoStateBehavior
anyItem(
)
  → GotoStateBehavior
count(
)
  → number
everyItem(
)
  → GotoStateBehavior
firstItem(
)
  → GotoStateBehavior
item(
index)
  → GotoStateBehavior
itemByID(
id)
  → GotoStateBehavior
itemByName(
name)
  → GotoStateBehavior
itemByRange(
from, to)
  → GotoStateBehavior
lastItem(
)
  → GotoStateBehavior
middleItem(
)
  → GotoStateBehavior
nextItem(
obj)
  → GotoStateBehavior
previousItem(
obj)
  → GotoStateBehavior
toSource(
)
  → string
add(
[withProperties])
  → GotoStateBehavior
Creates a new GotoStateBehavior.
withProperties Object Initial values for properties of the new GotoStateBehavior (Optional)
anyItem(
)
  → GotoStateBehavior
Returns any GotoStateBehavior in the collection.
count(
)
  → number
Displays the number of elements in the GotoStateBehavior.
everyItem(
)
  → GotoStateBehavior
Returns every GotoStateBehavior in the collection.
firstItem(
)
  → GotoStateBehavior
Returns the first GotoStateBehavior in the collection.
item(
index)
  → GotoStateBehavior
Returns the GotoStateBehavior with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → GotoStateBehavior
Returns the GotoStateBehavior with the specified ID.
id number The ID.
itemByName(
name)
  → GotoStateBehavior
Returns the GotoStateBehavior with the specified name.
name string The name.
itemByRange(
from, to)
  → GotoStateBehavior
Returns the GotoStateBehaviors within the specified range.
from The GotoStateBehavior, index, or name at the beginning of the range. Can accept: GotoStateBehavior, Long Integer or String.
to The GotoStateBehavior, index, or name at the end of the range. Can accept: GotoStateBehavior, Long Integer or String.
lastItem(
)
  → GotoStateBehavior
Returns the last GotoStateBehavior in the collection.
middleItem(
)
  → GotoStateBehavior
Returns the middle GotoStateBehavior in the collection.
nextItem(
obj)
  → GotoStateBehavior
Returns the GotoStateBehavior whose index follows the specified GotoStateBehavior in the collection.
obj GotoStateBehavior The GotoStateBehavior whose index comes before the desired GotoStateBehavior.
previousItem(
obj)
  → GotoStateBehavior
Returns the GotoStateBehavior with the index previous to the specified index.
obj GotoStateBehavior The index of the GotoStateBehavior that follows the desired GotoStateBehavior.
toSource(
)
  → string
Generates a string which, if executed, will return the GotoStateBehavior.