Please enable JavaScript to view this site.

Returns a property value of active parameter or active multi-choice value during an iteration of parameters and multi-choice values of a configuration. Properties of reference type can be followed to instead return a property of the referenced object. If no matching property is found, then an empty string is returned.

 

string ActiveParameter(string propertyName; [string propertyName2]; ...)

 

propertyName

The name of a property to read.

propertyName2

Optional name of a property to read from an object that is referenced by the first property.

Examples

ActiveParameter("Title")

Returns the title of active parameter or active multi-choice value. In case of a multi-choice value the returned string contains both the parameter title and the value title separated by ", ". If only the title of the multi-choice value is desired use the function ActiveParamValue.

 

ActiveParameter("Value")

Returns the value of active parameter or active multi-choice value converted to a string.

Note! Boolean values are returned as "Yes" or "No" for display reasons. Bool parameters and multi-choice values with "three-state" active can also have the value "Indeterminate".

 

ActiveParameter("Type")

Returns the data type of active parameter or active multi-choice value. Possible return values are "bool", "double", "int" and "string".

 

ActiveParameter("Class")

Returns the class of active parameter. Possible return values are "BoolParam", "DoubleParam", "IntParam", "LookupParam", "MultiChoiceParam" and "StringParam".

  

Keyboard Navigation

F7 for caret browsing
Hold ALT and press letter

This Info: ALT+q
Page Header: ALT+h
Topic Header: ALT+t
Topic Body: ALT+b
Contents: ALT+c
Search: ALT+s
Exit Menu/Up: ESC