Child pages
  • Variable

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Divcache
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
styleindexdisplay: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.

true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable
id

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Property SummaryProperty 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
Table Row (tr)
Table Cell (td)
String
Table Cell (td)scopeName
The name of the variable. Table Cell (td)variableType
The name of the scope. Table Row (tr)
Table Cell (td)
Number
The type of the variable. HTML Table

propertyclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col
Table Head (thead) Table Row (tr)styleheight:30px; Table Head (th)colspan2Property Details Table Body (tbody)ididcomment Table Row (tr)name

Table Cell (td)

comment

Table Row (tr)id

des Table Cell (td) DivclasssIndent
Property for setting and getting the jsdoc text (comment) of the script variable.
tr
idtdret

Returns

Divclass

sIndentString - 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 clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
defaultValuename

defaultValue

dessIndent
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)id
ret

Table Cell (td)

Returns

divsIndentclients

class

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) 

Supported Clients

sIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow
namename

name

dessIndent
The name of the variable.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
scopeNamename

scopeName

dessIndent
The name of the scope.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
variableTypename

variableType

dessIndent
The type of the variable. Can be one of: TEXT, INTEGER, NUMBER, DATETIME or MEDIA.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow