Child pages
  • Variable

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
{div:style=}
Wiki Markup
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



Enter additional information related to this 'class'

inside

the

\

{div}

macro

with

'id=description'

{div} {div:id=description}{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#comment] Property for setting and getting the jsdoc text (comment) of the script variable.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#defaultValue] The default value of the variable.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#name] The name of the variable.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#scopeName] The name of the scope.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#variableType] The type of the variable.{td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=comment}{tr:id=name}{td}h6.comment{td}{tr}{tr:id=des}{td}{div:class=sIndent}Property for setting and getting the jsdoc text (comment) of the script variable.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- the value of the jsdoc text (comment) of the script variable{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=defaultValue}{tr:id=name}{td}h6.defaultValue{td}{tr}{tr:id=des}{td}{div:class=sIndent}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

Div
iddescription


HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#defaultValue
The default value of the variable.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#name
The name of the variable.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#scopeName
The name of the scope.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#variableType
The type of the variable.

HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
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'".

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=name}{tr:id=name}{td}h6.name{td}{tr}{tr:id=des}{td}{div:class=sIndent}The name of the variable.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=scopeName}{tr:id=name}{td}h6.scopeName{td}{tr}{tr:id=des}{td}{div:class=sIndent}The name of the scope.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=variableType}{tr:id=name}{td}h6.variableType{td}{tr}{tr:id=des}{td}{div:class=sIndent}The type of the variable. Can be one of: TEXT, INTEGER, NUMBER, DATETIME or MEDIA.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

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)