States

A collection of states.

Methods

Stateadd ([withProperties:
Object])
Creates a new State.

Parameter	Type	Description
withProperties	Object	Initial values for properties of the new State (Optional)

StateanyItem ()
Returns any State in the collection.

number count ()
Displays the number of elements in the State.

Array of StateeveryItem ()
Returns every State in the collection.

StatefirstItem ()
Returns the first State in the collection.

Stateitem (index:
any)
Returns the State with the specified index or name.

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

StateitemByID (id:
number)
Returns the State with the specified ID.

Parameter	Type	Description
id	number	The ID.

StateitemByName (name:
string)
Returns the State with the specified name.

Parameter	Type	Description
name	string	The name.

Array of StateitemByRange (from:
any, to:
any)
Returns the States within the specified range.

Parameter	Type	Description
from	State Long Integer String	The State, index, or name at the beginning of the range. Can accept: State, Long Integer or String.
to	State Long Integer String	The State, index, or name at the end of the range. Can accept: State, Long Integer or String.

StatelastItem ()
Returns the last State in the collection.

StatemiddleItem ()
Returns the middle State in the collection.

StatenextItem (obj:
State)
Returns the State whose index follows the specified State in the collection.

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

StatepreviousItem (obj:
State)
Returns the State with the index previous to the specified index.

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

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

Element of:

Button.states