Move

Move

Description

Move a State object within a States collection.

Syntax

someStates.Move(indexState, indexBefore, indexAfter)

Parameter Description

someStates a States collection.

indexState An integer, or a string, or a object specifying the index of the State object to move.

indexBefore Optional. An integer, or a string, or a State object specifying where the State object is to be moved. The State object will be positioned before the specified State object.

indexAfter Optional. An integer, or a string, or a State object specifying where the State object is to be moved. The State object will be positioned after the specified State object.

Either indexBefore or indexAfter must be given, but not both.

Remarks

If indexBefore is numeric, it may have a value from 0 to someStates.Count (inclusive). If its value is 0, the item will be moved to the beginning of the collection. If its value is someStates.Count, the item will be moved to the end of the collection.

If indexAfter is numeric, it may have a value from -1 to someStates.Count - 1 (inclusive). If its value is -1, the item will be moved to the beginning of the collection. If its value is someStates.Count -1, the item will be moved to the end of the collection.

Return Value

the State object moved.

Applies To

States

Parameter	Description
someStates	a States collection.
indexState	An integer, or a string, or a object specifying the index of the State object to move.
indexBefore	Optional. An integer, or a string, or a State object specifying where the State object is to be moved. The State object will be positioned before the specified State object.
indexAfter	Optional. An integer, or a string, or a State object specifying where the State object is to be moved. The State object will be positioned after the specified State object.