Child pages
  • Variable
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »


Property Summary
String #comment
Property for setting and getting the jsdoc text (comment) of the script variable.
String #defaultValue
The default value of the variable.
String #name
The name of the variable.
String #scopeName
The name of the scope.
Number #variableType
The type of the variable.

Property Details
comment
Property for setting and getting the jsdoc text (comment) of the script variable.
Returns
String – the value of the jsdoc text (comment) of the script variable
defaultValue

The default value of the variable.

It is interpreted as a JS expression.

For form variables ,setting this property requires the form instances to be destroyed (history.remove("formName")).
If you want to use a default value for a newly created variable create the variable using the 3 parameter version newVariable(name,type,defaultValue).

For INTEGER variables it can be an integer constant, like 10 for example.
For NUMBER variables it can be a real constant, like 22.41. For DATETIME
variables it can be "now", or a JS expression like "new Date()". For TEXT
variables it can be any string surrounded with quotes, like "'some text'".

Returns
name
The name of the variable.
Returns
scopeName
The name of the scope.
Returns
variableType
The type of the variable. Can be one of: TEXT, INTEGER, NUMBER, DATETIME or MEDIA.
Returns
  • No labels