Child pages
  • Variable

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
comment
Property for setting and getting the jsdoc text (comment) of the script variable.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
defaultValue
The default value of the variable.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
name
The name of the variable.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
scopeName
The name of the scope.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
variableType
The type of the variable.



HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Details
Table Body (tbody)
idcomment
Table Row (tr)
idname
Table Cell (td)

comment

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Property for setting and getting the jsdoc text (comment) of the script variable.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - the value of the jsdoc text (comment) of the script variable
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddefaultValue
Table Row (tr)
idname
Table Cell (td)

defaultValue

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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'".

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idname
Table Row (tr)
idname
Table Cell (td)

name

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the variable.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idscopeName
Table Row (tr)
idname
Table Cell (td)

scopeName

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the scope.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idvariableType
Table Row (tr)
idname
Table Cell (td)

variableType

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The type of the variable. Can be one of: TEXT, INTEGER, NUMBER, DATETIME or MEDIA.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)