Structure

Block

Represents a block to group statements. A Block element allows the clustering and naming of statements for a better organization of the code.

Syntax

Block ( [Name] , Block )

Parameters

-

Block Represents the list of statements. Type: Any

Return Type

Void

Case

Represents a case element for a Switch structure element. If the evaluated expression is found to be TRUE, the code in the following Branch is executed.

Syntax

Case ( Expression [, Branch] )

Parameters

Expression Condition that is used to determine if the case matches. Type: Any

Branch (optional) List of statements which will be executed if the case matches. Type: Any

Return Type

Case

Comment

Void Comment( String Value ) Allows inline comments (has no effect on execution).

Syntax

Void Comment(
    String Value
)

Parameters

Value (optional) The inline comment. Type: String

Return Type Void

DoWhile

Takes a condition as input and evaluates it. As long as this condition evaluates to TRUE, the Statements in the loop will be executed.

Syntax

DoWhile ( Condition , Loop )

Parameters

Condition Condition which is evaluated. Type: Boolean

Loop List of statements which will be executed if condition is satisfied. Type: Any

Return Type

Void

Error

Represents an error in the script execution. Takes a String as input which will be displayed as error message.

Syntax

Error ( Message )

Parameters

Message Message which is shown in case of an error. Type: String

Return Type

Exit

ForEach

The ForEach loop takes a list of objects identified with ObjectName as input and executes a list of statements for each item in that list individually.

Syntax

ForEach ( Objects , ObjectName , Loop )

Parameters

Objects List of objects which the operation is performed on. Type: List<Object>

ObjectName Variable Name to identify the object in the condition. Type: String

Loop List of statements which are executed for each object. Type: Any

Return Type

Void

IfThenElse

Takes a condition as input. If the condition evaluates to TRUE, the statements in the Then block will be executed. If the condition evaluates to FALSE, the statements in the Else Blocks will be executed.

Syntax

IfThenElse ( Condition , Then [, Else] )

Parameters

Condition Condition which is evaluated. Type: Boolean

Then List of statements executed if the condition is TRUE. Type: Any

Else (optional) List of statements executed if the condition is FALSE. Type: Any

Return Type

Void

IfThenElseExpression

Returns the Then value if the Condition evaluates to TRUE; returns the Else value otherwise (aka conditional operator, ternary operator, ternary if, inline if or iif.

Syntax

Any IfThenElseExpression(
    Boolean Condition,
    params Any Then,
    params Any Else
)

Parameters

Condition The condition to check. Type Boolean

Then The value to return if the condition evaluates to TRUE. Type Any

Else The value to return if the condition evaluates to FALSE. Type Any

Return Type

Any

Return

Terminates the script and returns the value of the expression as the result.

Syntax

Return ( Expression )

Parameters

Expression The expression of the value to return. Type: Any

Return Type

Exit

Switch

Represents a switch structure element. When a matching case branch is empty, then no branch actions are executed.

Syntax

Switch ( Expression [, Default] [, Cases] )

Parameters

Expression Expression which is used to match. Type: Any

Default (optional) Specifies the default case of the switch case expression. Type: Any

Cases (optional) A list of cases that are matched against. Type: List<Case>

Return Type

Void

TryCatch

Represents a try-catch structure element.

Syntax

TryCatch ( Try , Catch )

Parameters

Try List of statements which can throw an exception while executed Type: Any

Catch List of statements which are executed in case of an error. Type: Void

Return Type

Void

TypeOf

Returns the type of a value as a string. Following types are supported: Boolean, Byte, Char, DateTime, Numeric, Double, Float, Guid, Integer, Long, Short, String, and TimeSpan.

Syntax

TypeOf ( Value )

Parameters

Value The value to get the type from. Type: Any

Return Type

String

While

Represents a while-loop structure element. The while structure executes a list of statements while the conditions is TRUE.

Syntax

While ( Condition , Loop )

Parameters

Condition Condition which is evaluated. Type: Boolean

Loop List of statements which is executed while the condition is TRUE. Type: Any

Return Type

Void