Previous Topic: Out ObjectNext Topic: Tools Object


Parameters Object

Provides access to metric ’s parameters, as follows:

Dump

Returns a list of all parameters (Name, Type and Value)

IsDate(<ParamName>)

Returns True if a specified parameter is of Date type; otherwise, returns False.

IsEntryDate(<TableName>,<RowName>,<ColumnName>)

Returns True if a specified Table entry is of Date type; otherwise, returns False.

IsEntryExist(<TableName>,<RowName>,<ColumnName>)

Returns True if a specified Table entry exists; otherwise, returns False.

IsEntryNumeric(<TableName>,<RowName>,<ColumnName>)

Returns True if a specified Table entry is of Numeric type; otherwise, returns False.

IsEntryText(<TableName>,<RowName>,<ColumnName>)

Returns True if a specified Table entry is of String type; otherwise, returns False.

IsExist(<ParamName>)

Returns True if a parameter with the specified name exists; otherwise, returns False.

Note: IsExist does not work on contract parameters.

IsNumeric(<ParamName>)

Returns True if a specified parameter is of Numeric type; otherwise, returns False.

IsTable(<ParamName>)

Returns True if a specified parameter is a Table; otherwise, returns False.

IsText(<ParamName>)

Returns True if a specified parameter is of String type; otherwise, returns False.

Parameters(<ParamName>)

Returns a value associated with a specified parameter. If the parameter is not found, run-time error is generated.

Parameters(<ParamName>)(<RowName>)(<ColumnName)

Returns a cell value inside a table parameter.

Parameters(<ParamName>, <RowName>

Returns a row from a table parameter as a script map. To navigate between the map items, use the parameters.item attribute.