Child pages
  • Variable

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{hidden}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden}
{sub-section:description|text=}{sub-section}\\ 

{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|class=node}{tr:id=name}{td}h6.comment{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:comment_des|trigger=button|text=}{sub-section}{sub-section:comment_des|trigger=none|class=sIndent}PropertyReplace for setting and getting the jsdoc text (comment) of the script variable.with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:comment_snc|trigger=button|text=}{sub-section}{sub-section:comment_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:comment_prs|trigger=button|text=}{sub-section}{sub-section:comment_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:comment_ret|trigger=button|text=}{sub-section}{sub-section:comment_ret|trigger=none|class=sIndent}[String] -- the value of the jsdoc text (comment) of the script variable{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:comment_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:comment_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:comment_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:comment_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:comment_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:comment_sam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=defaultValue|class=node}{tr:id=name}{td}h6.defaultValue{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:defaultValue_des|trigger=button|text=}{sub-section}{sub-section:defaultValue_des|trigger=none|class=sIndent}TheReplace 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 paramaeter 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'".{with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:defaultValue_snc|trigger=button|text=}{sub-section}{sub-section:defaultValue_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:defaultValue_prs|trigger=button|text=}{sub-section}{sub-section:defaultValue_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:defaultValue_ret|trigger=button|text=}{sub-section}{sub-section:defaultValue_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:defaultValue_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:defaultValue_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:defaultValue_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:defaultValue_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:defaultValue_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:defaultValue_sam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=name|class=node}{tr:id=name}{td}h6.name{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:name_des|trigger=button|text=}{sub-section}{sub-section:name_des|trigger=none|class=sIndent}TheReplace name of the variable.with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:name_snc|trigger=button|text=}{sub-section}{sub-section:name_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:name_prs|trigger=button|text=}{sub-section}{sub-section:name_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:name_ret|trigger=button|text=}{sub-section}{sub-section:name_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:name_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:name_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:name_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:name_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:name_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:name_sam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=scopeName|class=node}{tr:id=name}{td}h6.scopeName{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:scopeName_des|trigger=button|text=}{sub-section}{sub-section:scopeName_des|trigger=none|class=sIndent}The name of the scope.Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:scopeName_snc|trigger=button|text=}{sub-section}{sub-section:scopeName_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:scopeName_prs|trigger=button|text=}{sub-section}{sub-section:scopeName_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:scopeName_ret|trigger=button|text=}{sub-section}{sub-section:scopeName_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:scopeName_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:scopeName_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:scopeName_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:scopeName_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:scopeName_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:scopeName_sam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=variableType|class=node}{tr:id=name}{td}h6.variableType{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:variableType_des|trigger=button|text=}{sub-section}{sub-section:variableType_des|trigger=none|class=sIndent}TheReplace type of the variable. Can be one of: TEXT, INTEGER, NUMBER, DATETIME or MEDIA.with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:variableType_snc|trigger=button|text=}{sub-section}{sub-section:variableType_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:variableType_prs|trigger=button|text=}{sub-section}{sub-section:variableType_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:variableType_ret|trigger=button|text=}{sub-section}{sub-section:variableType_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:variableType_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:variableType_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:variableType_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:variableType_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:variableType_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:variableType_sam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}