{div: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 AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.\\ \\ 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}Event Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#onClose]
The method that is executed when a solution closes.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onDataBroadcast]
Method that is executed when data broadcast occurs.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#onError]
The method that is executed when a solution opens and an error occurs.{td}{tr}{tbody}{tbody}{tr}{td}{td}{td}[#onOpen]
The method that is executed when a solution opens.{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}[Number]{td}{td}[#firstForm]
Cache
index
true
refresh
100d
showRefresh
true
id
doc
title
Refresh page
showDate
true
retry
Enable
servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClientservoy sSummary12%30%58%height: 30px;3Property SummaryThe first form that loads when a solution is deployed.The i18n database server connection and database table that stores the i18n keys for a solution.The name of the login form that loads when a solution is deployed.Get the first module that is also a login solution.The list of modules that have been added to a solution.Flag that tells if authentication is needed in order to access the solution.The type of a solution; can be "Normal" (non-module), "Module", "Web client only", "Smart client only", "Login", "Authenticator", "Pre-import hook module", "Post-import hook module", "Mobile".The custom CSS used by the solution (a MEDIA lib entry).The direction that text is displayed.The menu bar title of a solution.servoy sSummary12%30%58%height: 30px;3Event SummaryThe method that is executed when a solution closes.voidMethod that is executed when data broadcast occurs.The method that is executed when a solution opens and an error occurs.voidThe method that is executed when a solution opens.propertyservoy sDetail2100%height:30px2Property DetailsfirstFormname
firstForm
dessIndent
The first form that loads when a solution is deployed.
.
If unchecked, the Smart Client will always require authentication, regardless of this setting.
If checked, authentication is required, and either a provided loginSolution or otherwise the default Servoy login mechanism will be used.
If default Servoy login mechanism is used, the "servoy.webclient.basic.authentication" setting on the Admin Page can be used to enable the use of the standard browser basic authentication.
The custom CSS used by the solution (a MEDIA lib entry). It can reference other media resources (even additional .css through relative '@import' statements).
For NGClient - this CSS will be available directly in the browser.
Options include:
DEFAULT
left to right
right to left
locale specific
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowtitleTextname
titleText
dessIndent
The menu bar title of a solution.
{td}{tr}{tbody}{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=onClose-Boolean}{tr:id=name}{td}h6.onClose{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} force -- if false then solution close can be stopped by returning false
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onDataBroadcast-String_Number_JSDataSet_Boolean}{tr:id=name}{td}h6.onDataBroadcast{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dataSource -- table data source
\{[Number]} action -- see SQL\_ACTION\_TYPES constants
\{[JSDataSet]} pks -- affected primary keys
\{[Boolean]} cached -- data was cached
{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onError-}{tr:id=name}{td}h6.onError{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}ex -- exception to handle
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=onOpen}{tr:id=name}{td}h6.onOpen{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=firstForm}{tr:id=name}{td}h6.firstForm{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=i18nDataSource}{tr:id=name}{td}h6.i18nDataSource{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loginForm}{tr:id=name}{td}h6.loginForm{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loginSolutionName}{tr:id=name}{td}h6.loginSolutionName{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=modulesNames}{tr:id=name}{td}h6.modulesNames{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=mustAuthenticate}{tr:id=name}{td}h6.mustAuthenticate{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=solutionType}{tr:id=name}{td}h6.solutionType{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=textOrientation}{tr:id=name}{td}h6.textOrientation{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=titleText}{tr:id=name}{td}h6.titleText{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}ret
The method that is executed when a solution closes. The default is -none-.
prs
Parameters
sIndentforceif false then solution close can be stopped by returning falseret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowonDataBroadcastname
onDataBroadcast(dataSource, action, pks, cached)
dessIndent
Method that is executed when data broadcast occurs. The default is -none-.
prs
Parameters
sIndentdataSourcetable data sourceactionsee SQL_ACTION_TYPES constantspksaffected primary keyscacheddata was cachedclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowonErrorname
onError(ex)
dessIndent
The method that is executed when a solution opens and an error occurs. The default is -none.
prs
Parameters
sIndentexexception to handleret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowonOpenname
onOpen(arg, queryParams)
dessIndent
The method that is executed when a solution opens. The default is -none-.
prs
Parameters
sIndentargstartup argument part of the deeplink url with which the Client was startedqueryParamsall query parameters of the deeplink url with which the Client was startedclients