States


Description

Retrieves a collection of all State objects belonging to a Node or an element of the SharedDomains collection.

Syntax

Getting:

aNode.States

aSharedDomain(index0).States

aNode.States(index)

aSharedDomain(index0).States(index)

Setting:

Set aNode.States = someStates

Set aSharedDomain(index0).States(index) = someStates

 

Parameter Description
aNode a Node object.
aSharedDomain(index0) an element from a SharedDomains collection.
(index) Optional. An integer, or a string, or a State object specifying the index value of the state to retrieve. Integer indexes are zero-based, meaning the first state in the collection has index 0. A string index is valid only if the string is the name of a state in the collection. A State object is valid only if it is in the States collection.
someStates a States collection from which to copy. Copying usually has two steps: first, adding or deleting states to match the length of someStates, and, second, renaming states to match the names of the states in someStates. If, however, States belongs to a node and someStates is a shared domain then the node just starts sharing the shared domain.

Remarks

Shareable States collections have a nonempty name and are elements of the SharedDomains collection.  Warning: The SharedDomains functionality may be phased out in the future. Its use is not recommended.

As with all MSBN3 collections, the elements of this collection can be enumerated. Also, as with other MSBN3 collections, the index numbers, key strings, and key objects of this collection can be enumerated. See "Collections and Maps: an Overview" for details.

Properties

CountDescription, ExistingKey, Item, Model, MSBN, Name, Owner, Ref, Shareable

Methods

Add, Copy, Move, Remove

Collections

Indexes, Keys, KeyObjects

Applies To

Node, an element of a SharedDomains collection

Also See

Collections and Maps: an Overview