ParameterList
This object is used to store strings, doubles and integers as ‘properties’ of an object such as the job. The parameter has a name such as “DocumentCreator”, a type which is either string, double (a floating point number such as 1.2345) or an integer ( a whole number such as 7) and the value you assign for the parameter.
For the job you would use the .JobParameters property to access the ParameterList for the job.
Methods
:GetDouble(string parameter_name, double default_value, bool create_if_not_exist)
Retrieve a double with the passed name, if no value with passed name returns passed default value
- parameter_name - string - the name of the parameter default_value - double - the value which will be returned if there is no existing value stored create_if_not_exist - bool - if true the default value will be stored in list if no existing value
:GetInt(string parameter_name, integer default_value, bool create_if_not_exist)
Retrieve an integer with the passed name, if no value with passed name returns passed default value
- parameter_name - string - the name of the parameter value - integer - the value which will be returned if there is no existing value stored create_if_not_exist - bool - if true the default value will be stored in list if no existing value
:ParameterExists(string parameter_name, utParameterType type)
Returns true if there is an existing parameter with passed name and type.
- parameter_name - string - the name of the parameter type - utParameterType - the type of parameter
:SetBool(string parameter_name, bool default_value, bool create_if_not_exist)
Retrieve a Boolean flag (true / false) with the passed name, if no value with passed name returns passed default value
- parameter_name - string - the name of the parameter default_value - bool - the value which will be returned if there is no existing value stored create_if_not_exist - bool - if true the default value will be stored in list if no existing value
:SetBool(string parameter_name, bool value)
Store a Boolean flag (true / false) with the passed name and value
- parameter_name - string - the name which will be used to store and retrieve the value value - bool - the value which will be stored in the parameter list
:SetDouble(string parameter_name, double value)
Store a double with the passed name and value
- parameter_name - string - the name which will be used to store and retrieve the value value - double - the value which will be stored in the parameter list
:SetInt(string parameter_name, integer value)
Store an integer with the passed name and value
- parameter_name - string - the name which will be used to store and retrieve the value value - integer - the value which will be stored in the parameter list
:SetString(string parameter_name, string default_value, bool create_if_not_exist)
Retrieve a string with the passed name, if no value with passed name returns passed default value
- parameter_name - string - the name of the parameter default_value - string - the value which will be returned if there is no existing value stored create_if_not_exist - bool - if true the default value will be stored in list if no existing value
- ParameterList.UTP_DOUBLE
- ParameterList.UTP_INT
- ParameterList.UTP_BOOL
- ParameterList.UTP_STRING
:SetString(string parameter_name, string value)
Store a string with the passed name and value
- parameter_name - string - the name which will be used to store and retrieve the value value - string - the value which will be stored in the parameter list
References
Please Note: The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 2.05, published September 12, 2018. by Vectric Ltd. Most current document from Vertric can be downloaded at Vertric Developer Information