Skip to main content
MacroParameter class

Constructors

MacroParameter()

Initializes a new instance of the MacroParameter class.

MacroParameter(String,String,Map,String,String,Bool)

Initializes a new instance of the MacroParameter class.

MacroParameter(String,String,Map,String,String,Bool,String,Bool)

Initializes a new instance of the MacroParameter class.

Methods

getControlConfig()

Gets the optional control configuration values that influence how the input control behaves.
Returns: CRMScript.Native.Map

getDescription()

Returns a longer description of the parameter.
Returns: CRMScript.Global.String
Can for instance be used as help in a form.

getIsFixedValue()

Returns true if the value is fixed, and false if it is read from another task or the environment.
Returns: CRMScript.Global.Bool - True if the value is fixed; otherwise, false.

getIsOptional()

Returns true if the value is optional, and false if it is mandatory.
Returns: CRMScript.Global.Bool - True if the value is optional; false if mandatory.

getLabel()

Returns the label for the parameter when displayed in a form.
Returns: CRMScript.Global.String - The label for the parameter when displayed in a form.

getName()

Returns the name of the parameter.
Returns: CRMScript.Global.String - The name of the parameter.
The name is used for accessing the parameter.

getSourcePath()

Returns the source path of the object it is called from.
Returns: CRMScript.Global.String - The source path of the object it is called from.

getType()

Returns the type of the parameter.
Returns: CRMScript.Global.String
Used for displaying correct control in form. Available types:
  • AnchorLine
  • InfoFields
  • Grid
  • HR
  • BR
  • SubHeader
  • ParserCode
  • Messages
  • EjScript
  • HtmlGrid
  • Planner
  • StaticGrid
  • DrillDown
  • GenericGrid
  • InfoFields2
  • ExtraTableEntriesGrid
  • DirectedAcyclicGraph
  • EjscriptElement
  • Chart
  • WhereChart
  • ListRecipients
  • EntityCard

getValue()

If the parameter is a fixed value, this function will return that value.
Returns: CRMScript.Global.String

setControlConfig(Map)

Sets the optional configuration values for the type. The configuration will influence how the input control behaves.
Returns: CRMScript.Global.Void

setDescription(String)

Sets a longer description of the parameter. This description can for instance be used in as help in a form.
Returns: CRMScript.Global.Void

setIsFixedValue(Bool)

Sets whether or not the parameter is a fixed value.
Returns: CRMScript.Global.Void

setIsOptional(Bool)

Sets whether or not the parameter is optional.
Returns: CRMScript.Global.Void

setLabel(String)

Sets the label of the parameter when displayed in form.
Returns: CRMScript.Global.Void

setName(String)

Sets the name of the parameter.
Returns: CRMScript.Global.Void
Parameters are accessed by their name.

setSourcePath(String)

Sets the parameter’s source path.
Returns: CRMScript.Global.Void

setType(String)

Sets the type of the parameter.
Returns: CRMScript.Global.Void
Available types:
  • AnchorLine
  • InfoFields
  • Grid
  • HR
  • BR
  • SubHeader
  • ParserCode
  • Messages
  • EjScript
  • HtmlGrid
  • Planner
  • StaticGrid
  • DrillDown
  • GenericGrid
  • InfoFields2
  • ExtraTableEntriesGrid
  • DirectedAcyclicGraph
  • EjscriptElement
  • Chart
  • WhereChart
  • ListRecipients
  • EntityCard

setValue(String)

Sets the value of the parameter, given that the parameter is a fixed value.
Returns: CRMScript.Global.Void