script
FormatParameter

This class is used to define a format parameter used in a script. There must be one parameter object for each parameter specified in a script version. These parameters are created when a version is created and can not be changed.



public class FormatParameter

Properties
format The format (velocity only) for the parameter (must be the same as the one defined in the script version).

type=string
default=
minimum=0
maximum=1000

spanObjectPointer A pointer to the parent spanEnabled object.

type=string
access=read-only
default=
minimum=0
maximum=252

useRegEx Identifies if the format is a regular expression (not currently used, future).

type=boolean
default=false

 
Overridden Properties
paramType The type of the parameter.

default=format

 
Properties inherited from script.AbstractMinMaxParameter
max, min
 
Properties inherited from script.AbstractParameter
checkBoxValue, checkBoxValueUIName, impact, required, runtime, script.ParameterMethod-Set, unset, value
 
Properties inherited from script.AbstractBaseParameter
displayName, mode, paramType, parameterName, script.AbstractParameterAction-Set, tooltip, uiOrder, xCoord, yCoord
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed