Class

States

 A collection of states.

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

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

ParameterTypeDescription
indexnumberThe index.

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

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new State (Optional)

State anyItem ()
Returns any State in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromLong Integer
State
String
The State, index, or name at the beginning of the range. Can accept: State, Long Integer or String.
toLong Integer
State
String
The State, index, or name at the end of the range. Can accept: State, Long Integer or String.

State lastItem ()
Returns the last State in the collection.

State middleItem ()
Returns the middle State in the collection.

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

ParameterTypeDescription
objStateThe State whose index comes before the desired State.

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

ParameterTypeDescription
objStateThe 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

CheckBox.states

MultiStateObject.states

RadioButton.states

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