ScenarioCollection

ScenarioCollection class

Represents the list of scenarios.

Properties

NameTypeDescription
ActiveIndexNumberGets and sets which scenario is selected.
LastSelectedNumberIndicates which scenario was last selected by the user to be run/shown.
CountNumber
Item (int)ScenarioGets the Scenario object by the index.

Methods

NameDescription
addAdds a scenario.
clear
removeAt
iterator
getReserved for internal use.
containsReserved for internal use.
indexOfReserved for internal use.

ScenarioCollection.ActiveIndex property

Gets and sets which scenario is selected.

Type: Number

ScenarioCollection.LastSelected property

Indicates which scenario was last selected by the user to be run/shown.

Type: Number

ScenarioCollection.Count property

Type: Number

ScenarioCollection.Item (int) property

Gets the Scenario object by the index.

Type: Scenario

add(name) (1 of 2)

Adds a scenario.

ParameterTypeDescription
nameStringThe name of scenario.

Returns: The index in the list of scenarios.


add(value) (2 of 2)

Reserved for internal use.

clear()

removeAt(index)

iterator()

get(index)

Reserved for internal use.

contains(value)

Reserved for internal use.

indexOf(value)

Reserved for internal use.