StateMachineTemplate.Region Method

StateMachineTemplateRegion Method

Creates a Region instance and precedes the definition of the Region's States.

Namespace: StaMa
Assembly: StaMa (in StaMa.dll) Version: 2.3.1.7

Syntax

public void Region(
	string initialStateName,
	bool hasHistory
)

Public Sub Region ( 
	initialStateName As String,
	hasHistory As Boolean
)

public:
void Region(
	String^ initialStateName, 
	bool hasHistory
)

member Region : 
        initialStateName : string * 
        hasHistory : bool -> unit

initialStateName: Type: SystemString
A String that defines the name of the Region's initial State.
hasHistory: Type: SystemBoolean
true if the Region shall have a shallow history; otherwise, false.

Exceptions

Exception	Condition
ArgumentNullException	The initialStateName is null or empty.
StateMachineException	A syntax error was detected with this or the preceeding Region, EndRegion, State, EndState or Transition statements.

Remarks

This method must be used paired with an StateMachineTemplate.EndRegion statement.

Each pair of enclosed StateMachineTemplate.State Overload ... EndState statements will add a State to the Region.