Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{hiddendiv:style=display: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 EXTRACTAUTO CHANGES FROMUPDATE THE PAGECONTENT ANDTHROUGH MERGETHE THEM BACK INTO SERVOY SOURCE{hiddenDOC GENERATOR{div}
{sub-sectiondiv:id=description|text=}{sub-sectiondiv}\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Command Summary{th}{tr}{table}\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Event Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#onHide]
The method that is triggered when another form is being activated.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onLoad]
The method that is triggered when a form is loaded/reloaded from the repository; used to alter elements, set globals, hide toolbars, 
etc; onShow method can also be assigned.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onRecordSelection]
The method that is triggered each time a record is selected.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onShow]
The method that is triggered EVERY TIME the form is displayed; an argument must be passed to the method if this is the first time the form is displayed.{td}{tr}{tbody}{table}\\ 

{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}[#dataSource]
The names of the database server and table that this form is linked to.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#encapsulation]
The encapsulation mode for the form (see JSForm constants for encapsulation mode constants).{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#name]
The name of the form.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#navigator]
The navigator (previously named "controller")
that is used to control/navigate to the form.{td}{tr}{tbody}{table}\\ 

{table:id=command|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Command Details{th}{tr}{table}\\ 

{table:id=event|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Event Details{th}{tr}{tbody:id=onHide-JSEvent|class=node}{tr:id=name}{td}h6.onHide{td}{tr}{builder-show:permission=edit}{tr:id=desprs}{td}{sub-section:onHide-JSEvent_des|trigger=button|text=}{sub-section}{sub-section:onHide-JSEvent_des|trigger=none|class=sIndent}Replace with description{sub-section*Parameters*\\{div:class=sIndent}\{[JSEvent]} event -- the event that triggered the action
{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sncret}{td}*SinceReturns*\\{sub-section:onHide-JSEvent_snc|trigger=button|text=}{sub-section}{sub-section:onHide-JSEvent_snc|trigger=none|class=sIndent} Replace with version info{sub-sectiondiv:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{builder-showtbody}{tbody:id=onLoad-JSEvent}{tr:id=name}{td}h6.onLoad{td}{tr}{tr:id=prs}{td}*Parameters*\\{sub-section:onHide-JSEvent_prs|trigger=button|text=}{sub-section}{sub-section:onHide-JSEvent_prs|trigger=none|div:class=sIndent}\{[JSEvent]} event -- the event that triggered the action
{sub-sectiondiv}{td}{tr}{tr:id=retclass=lastDetailRow}{td}{td}*Returns*\\{sub-section:onHide-JSEvent_ret|trigger=button|text=}{sub-section}{sub-section:onHide-JSEvent_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{tr}{tbody}{tbody:id=onRecordSelection-JSEvent}{tr:id=name}{td}h6.onRecordSelection{td}{tr}{builder-show:permission=edit}{tr:id=seeprs}{td}*Also seeParameters*\\{sub-section:onHide-JSEvent_see|trigger=button|text=}{sub-section}{div:div:class=sIndent}{sub-section:onHide-JSEvent_see|trigger=none}{sub-section}\{[JSEvent]} event -- the event that triggered the action
{div}{td}{tr}{builder-show}{builder-show:permission=edittr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onShow-Boolean_JSEvent}{tr:id=name}{td}h6.onShow{td}{tr}{tr:id=linkprs}{td}*External linksParameters*\\{sub-section:onHide-JSEvent_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:onHide-JSEvent_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:onHide-JSEvent_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:onHide-JSEvent_sam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onLoad-JSEvent|class=node}{tr:id=name}{td}h6.onLoad{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:onLoad-JSEvent_des|trigger=button|text=}{sub-section}{sub-section:onLoad-JSEvent_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:onLoad-JSEvent_snc|trigger=button|text=}{sub-section}{sub-section:onLoad-JSEvent_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:onLoad-JSEvent_prs|trigger=button|text=}{sub-section}{sub-section:onLoad-JSEvent_prs|trigger=none|class=sIndent}\{[JSEvent]} event -- the event that triggered the action
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=ret}{td}*Returns*\\{sub-section:onLoad-JSEvent_ret|trigger=button|text=}{sub-section}{sub-section:onLoad-JSEvent_ret|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:onLoad-JSEvent_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:onLoad-JSEvent_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:onLoad-JSEvent_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:onLoad-JSEvent_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:onLoad-JSEvent_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:onLoad-JSEvent_sam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onRecordSelection-JSEvent|class=node}{tr:id=name}{td}h6.onRecordSelection{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:onRecordSelection-JSEvent_des|trigger=button|text=}{sub-section}{sub-section:onRecordSelection-JSEvent_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:onRecordSelection-JSEvent_snc|trigger=button|text=}{sub-section}{sub-section:onRecordSelection-JSEvent_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:onRecordSelection-JSEvent_prs|trigger=button|text=}{sub-section}{sub-section:onRecordSelection-JSEvent_prs|trigger=none|class=sIndent}\{[JSEvent]} event -- the event that triggered the action
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=ret}{td}*Returns*\\{sub-section:onRecordSelection-JSEvent_ret|trigger=button|text=}{sub-section}{sub-section:onRecordSelection-JSEvent_ret|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:onRecordSelection-JSEvent_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:onRecordSelection-JSEvent_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:onRecordSelection-JSEvent_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:onRecordSelection-JSEvent_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:onRecordSelection-JSEvent_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:onRecordSelection-JSEvent_sam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onShow-Boolean_JSEvent|class=node}{tr:id=name}{td}h6.onShow{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:onShow-Boolean_JSEvent_des|trigger=button|text=}{sub-section}{sub-section:onShow-Boolean_JSEvent_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:onShow-Boolean_JSEvent_snc|trigger=button|text=}{sub-section}{sub-section:onShow-Boolean_JSEvent_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:onShow-Boolean_JSEvent_prs|trigger=button|text=}{sub-section}{sub-section:onShow-Boolean_JSEvent_prs|trigger=none|class=sIndent}\{[Boolean]} firstShow -- form is shown first time after load
\{[JSEvent]} event -- the event that triggered the action
{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=ret}{td}*Returns*\\{sub-section:onShow-Boolean_JSEvent_ret|trigger=button|text=}{sub-section}{sub-section:onShow-Boolean_JSEvent_ret|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:onShow-Boolean_JSEvent_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:onShow-Boolean_JSEvent_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:onShow-Boolean_JSEvent_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:onShow-Boolean_JSEvent_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:onShow-Boolean_JSEvent_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:onShow-Boolean_JSEvent_sam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{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=dataSource|class=node}{tr:id=name}{td}h6.dataSource{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:dataSource_des|trigger=button|text=}{sub-section}{sub-section:dataSource_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:dataSource_snc|trigger=button|text=}{sub-section}{sub-section:dataSource_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:dataSource_prs|trigger=button|text=}{sub-section}{sub-section:dataSource_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:dataSource_ret|trigger=button|text=}{sub-section}{sub-section:dataSource_ret|trigger=none|class=sIndent}[String]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:dataSource_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:dataSource_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:dataSource_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:dataSource_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:dataSource_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:dataSource_sam|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=encapsulation|class=node}{tr:id=name}{td}h6.encapsulation{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:encapsulation_des|trigger=button|text=}{sub-section}{sub-section:encapsulation_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:encapsulation_snc|trigger=button|text=}{sub-section}{sub-section:encapsulation_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:encapsulation_prs|trigger=button|text=}{sub-section}{sub-section:encapsulation_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:encapsulation_ret|trigger=button|text=}{sub-section}{sub-section:encapsulation_ret|trigger=none|class=sIndent}[Number] -- the encapsulation mode/level for the form{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:encapsulation_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:encapsulation_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:encapsulation_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:encapsulation_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:encapsulation_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:encapsulation_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}Replace 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=navigator|class=node}{tr:id=name}{td}h6.navigator{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:navigator_des|trigger=button|text=}{sub-section}{sub-section:navigator_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:navigator_snc|trigger=button|text=}{sub-section}{sub-section:navigator_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:navigator_prs|trigger=button|text=}{sub-section}{sub-section:navigator_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:navigator_ret|trigger=button|text=}{sub-section}{sub-section:navigator_ret|trigger=none|class=sIndent}[Number]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:navigator_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:navigator_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:navigator_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:navigator_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=sam}{td}*Sample*\\{sub-section:navigator_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:navigator_sam|trigger=none}{sub-section}{div}{td}{tr}{builder-showdiv:class=sIndent}\{[Boolean]} firstShow -- form is shown first time after load
\{[JSEvent]} event -- the event that triggered the action
{div}{td}{tr}{tr:class=lastDetailRow}{td}{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=dataSource}{tr:id=name}{td}h6.dataSource{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=encapsulation}{tr:id=name}{td}h6.encapsulation{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- the encapsulation mode/level for the form{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=name}{tr:id=name}{td}h6.name{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=navigator}{tr:id=name}{td}h6.navigator{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}