Child pages
  • RuntimeForm

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
{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:padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[controller]{td}{td}[#_super] Provides access to the methods of the parent of this form.{td}{tr}{tbody}{tbody}{tr}{td}[Array]{td}{td}[#alldataproviders] Get all dataproviders of the form.{td}{tr}{tbody}{tbody}{tr}{td}[Array]{td}{td}[#allmethods] Get all script names of the form.{td}{tr}{tbody}{tbody}{tr}{td}[Array]{td}{td}[#allnames] Get the names of all elements on the form as an array.{td}{tr}{tbody}{tbody}{tr}{td}[Array]{td}{td}[#allrelations] Get all relation names of the form.{td}{tr}{tbody}{tbody}{tr}{td}[Array]{td}{td}[#allvariables] Get all form variable names.{td}{tr}{tbody}{tbody}{tr}{td}[controller]{td}{td}[#controller] Get the controller of the form.{td}{tr}{tbody}{tbody}{tr}{td}[elements]{td}{td}[#elements] Get an array with the elements in the form.{td}{tr}{tbody}{tbody}{tr}{td}[JSFoundset]{td}{td}[#foundset] Get the foundset of the form.{td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=_super|class=node}{tr:id=name}{td}h6._super{td}{tr}{tr:id=des}{td}{sub-section:_super_des|text=|trigger=button}{sub-section}{sub-section:_super_des|trigger=none|class=sIndent}Provides access to the methods of the parent of this form.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:_super_snc|text=|trigger=button}{sub-section}{sub-section:_super_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:_super_prs|text=|trigger=button}{sub-section}{sub-section:_super_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:_super_ret|text=|trigger=button}{sub-section}{sub-section:_super_ret|trigger=none|class=sIndent}[controller]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:_super_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:_super_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:_super_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:_super_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:_super_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:_super_sam|trigger=none}{code:language=javascript}
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.

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)
RuntimeForm
Table Cell (td)
_super
Provides access to the methods of the parent of this form.
Table Row (tr)
Table Cell (td)
controller
Table Cell (td)
controller
Get the controller of the form.
Table Row (tr)
Table Cell (td)
elements
Table Cell (td)
elements
Get an array with the elements in the form.
Table Row (tr)
Table Cell (td)
JSFoundSet
Table Cell (td)
foundset
Get the foundset of the form.



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)
id_super
Table Row (tr)
idname
Table Cell (td)

_super

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Provides access to the methods of the parent of this form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
RuntimeForm
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer._super.some_method();
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=alldataproviders|class=node}{tr:id=name}{td}h6.alldataproviders{td}{tr}{tr:id=des}{td}{sub-section:alldataproviders_des|text=|trigger=button}{sub-section}{sub-section:alldataproviders_des|trigger=none|class=sIndent}Get all dataproviders of the form.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:alldataproviders_snc|text=|trigger=button}{sub-section}{sub-section:alldataproviders_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:alldataproviders_prs|text=|trigger=button}{sub-section}{sub-section:alldataproviders_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:alldataproviders_ret|text=|trigger=button}{sub-section}{sub-section:alldataproviders_ret|trigger=none|class=sIndent}[Array]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:alldataproviders_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:alldataproviders_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:alldataproviders_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:alldataproviders_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:alldataproviders_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:alldataproviders_sam|trigger=none}{code:language=javascript} var dataprovidersNames = forms.customer.alldataproviders; application.output("This form has " + dataprovidersNames.length + " data providers.") for (var i=0; i<dataprovidersNames.length; i++) application.output(dataprovidersNames[i]); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=allmethods|class=node}{tr:id=name}{td}h6.allmethods{td}{tr}{tr:id=des}{td}{sub-section:allmethods_des|text=|trigger=button}{sub-section}{sub-section:allmethods_des|trigger=none|class=sIndent}Get all script names of the form.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:allmethods_snc|text=|trigger=button}{sub-section}{sub-section:allmethods_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:allmethods_prs|text=|trigger=button}{sub-section}{sub-section:allmethods_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:allmethods_ret|text=|trigger=button}{sub-section}{sub-section:allmethods_ret|trigger=none|class=sIndent}[Array]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:allmethods_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allmethods_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:allmethods_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allmethods_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:allmethods_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allmethods_sam|trigger=none}{code:language=javascript} var methodNames = forms.customer.allmethods; application.output("This form has " + methodNames.length + " methods defined.") for (var i=0; i<methodNames.length; i++) application.output(methodNames[i]); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=allnames|class=node}{tr:id=name}{td}h6.allnames{td}{tr}{tr:id=des}{td}{sub-section:allnames_des|text=|trigger=button}{sub-section}{sub-section:allnames_des|trigger=none|class=sIndent}Get the names of all elements on the form as an array.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:allnames_snc|text=|trigger=button}{sub-section}{sub-section:allnames_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:allnames_prs|text=|trigger=button}{sub-section}{sub-section:allnames_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:allnames_ret|text=|trigger=button}{sub-section}{sub-section:allnames_ret|trigger=none|class=sIndent}[Array]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:allnames_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allnames_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:allnames_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allnames_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:allnames_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allnames_sam|trigger=none}{code:language=javascript} var names = forms.customer.allnames; application.output("This form has " + names.length + " named items.") for (var i=0; i<names.length; i++) application.output(names[i]); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=allrelations|class=node}{tr:id=name}{td}h6.allrelations{td}{tr}{tr:id=des}{td}{sub-section:allrelations_des|text=|trigger=button}{sub-section}{sub-section:allrelations_des|trigger=none|class=sIndent}Get all relation names of the form.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:allrelations_snc|text=|trigger=button}{sub-section}{sub-section:allrelations_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:allrelations_prs|text=|trigger=button}{sub-section}{sub-section:allrelations_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:allrelations_ret|text=|trigger=button}{sub-section}{sub-section:allrelations_ret|trigger=none|class=sIndent}[Array]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:allrelations_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allrelations_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:allrelations_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allrelations_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:allrelations_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allrelations_sam|trigger=none}{code:language=javascript} var relationsNames = forms.customer.allrelations; application.output("This form has " + relationsNames.length + " relations.") for (var i=0; i<relationsNames.length; i++) application.output(relationsNames[i]); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=allvariables|class=node}{tr:id=name}{td}h6.allvariables{td}{tr}{tr:id=des}{td}{sub-section:allvariables_des|text=|trigger=button}{sub-section}{sub-section:allvariables_des|trigger=none|class=sIndent}Get all form variable names.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:allvariables_snc|text=|trigger=button}{sub-section}{sub-section:allvariables_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:allvariables_prs|text=|trigger=button}{sub-section}{sub-section:allvariables_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:allvariables_ret|text=|trigger=button}{sub-section}{sub-section:allvariables_ret|trigger=none|class=sIndent}[Array]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:allvariables_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allvariables_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:allvariables_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allvariables_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:allvariables_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:allvariables_sam|trigger=none}{code:language=javascript} var varNames = forms.customer.allvariables; application.output("This form has " + varNames.length + " variables defined.") for (var i=0; i<varNames.length; i++) application.output(varNames[i]); {code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=controller|class=node}{tr:id=name}{td}h6.controller{td}{tr}{tr:id=des}{td}{sub-section:controller_des|text=|trigger=button}{sub-section}{sub-section:controller_des|trigger=none|class=sIndent}Get the controller of the form.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:controller_snc|text=|trigger=button}{sub-section}{sub-section:controller_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:controller_prs|text=|trigger=button}{sub-section}{sub-section:controller_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:controller_ret|text=|trigger=button}{sub-section}{sub-section:controller_ret|trigger=none|class=sIndent}[controller]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:controller_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:controller_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:controller_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:controller_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:controller_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:controller_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcontroller
Table Row (tr)
idname
Table Cell (td)

controller

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the controller of the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
controller
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.enabled = !forms.customer.controller.enabled;
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=elements|class=node}{tr:id=name}{td}h6.elements{td}{tr}{tr:id=des}{td}{sub-section:elements_des|text=|trigger=button}{sub-section}{sub-section:elements_des|trigger=none|class=sIndent}Get an array with the elements in the form.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:elements_snc|text=|trigger=button}{sub-section}{sub-section:elements_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:elements_prs|text=|trigger=button}{sub-section}{sub-section:elements_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:elements_ret|text=|trigger=button}{sub-section}{sub-section:elements_ret|trigger=none|class=sIndent}[elements]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:elements_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:elements_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:elements_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:elements_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:elements_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:elements_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idelements
Table Row (tr)
idname
Table Cell (td)

elements

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get an array with the elements in the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
elements
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var elems = forms.customer.elements;
application.output("This form has " + elems.length + " named elements.")
for (var i=0; i<elems.length; i++)
	application.output(elems[i].getName());
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=foundset|class=node}{tr:id=name}{td}h6.foundset{td}{tr}{tr:id=des}{td}{sub-section:foundset_des|text=|trigger=button}{sub-section}{sub-section:foundset_des|trigger=none|class=sIndent}Get the foundset of the form.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:foundset_snc|text=|trigger=button}{sub-section}{sub-section:foundset_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:foundset_prs|text=|trigger=button}{sub-section}{sub-section:foundset_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:foundset_ret|text=|trigger=button}{sub-section}{sub-section:foundset_ret|trigger=none|class=sIndent}[JSFoundset]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:foundset_see|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:foundset_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:foundset_link|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:foundset_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:foundset_sam|text=|trigger=button}{sub-section}{div:class=sIndent}{sub-section:foundset_sam|trigger=none}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idfoundset
Table Row (tr)
idname
Table Cell (td)

foundset

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the foundset of the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSFoundSet
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
application.output("selected index in form foundset: " + forms.customer.foundset.getSelectedIndex());
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Table Row (tr)
classlastDetailRow
Table Cell (td)