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'
servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClientservoy sSummary12%30%58%height: 30px;3Property SummaryThe first form that loads when a solution is deployed.
The menu bar title of a solution.This is the version of the solution
...
id
event
class
servoy sDetail
...
padding
0px
width
100%
Table Row (tr)
style
height: 30px;
Table Head (th)
colspan
1
Event Details
...
id
onClose-Boolean
Table Row (tr)
id
name
Table Cell (td)
onClose
...
id
des
...
class
sIndent
, this can be any kind of string but try to follow "Semantic Versioning".servoy sSummary12%30%58%height: 30px;3Event SummaryvoidThe method that is executed when
...
Table Row (tr)
id
prs
Table Cell (td)
Parameters
Div
class
sIndent
{Boolean} force – if false then solution close can be stopped by returning false
autosave results in validation or save failures.voidThe method that is to onOpen just that it executes before the login on solutions with a login form (not login soliution).The method that is executed when a solution closes.voidMethod that is executed when data broadcast occurs.The
...
Table Row (tr)
id
prs
Table Cell (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
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". These constants are defined in SolutionMetaData class.
The first form that loads when a solution is deployed.
NOTE: If the Login form is specified, then the firstForm is the first form that will load next after the loginForm.
Flag that tells if authentication is needed in order to access the solution.
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 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".
These constants are defined in SolutionMetaData class.
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.
ret
Returns
sIndentclients
Supported Clients
sIndentNGClientsam
Sample
sIdentjavascriptlastDetailRowtextOrientationname
textOrientation
dessIndent
The direction that text is displayed.
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.
ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowversionname
version
dessIndent
This is the version of the solution, this can be any kind of string but try to follow "Semantic Versioning".
This version is important when you are making modules that are distributed by the Servoy Package Manager.
Then this version is used to know what the developer has installed. This version should be in sync then with the webpackage.json file.
The method that is executed when autosave results in validation or save failures.
This is not called for save or validate calls that are triggered from javascript itself (databaseManager.saveData()), only when Servoy tries an auto save
because of some event like user clicking on the form itself or foundset selection change.
prs
Parameters
sIndentrecordMarkersan array of all the record markers that failed to validate or save.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowonBeforeLoginname
onBeforeLogin(|)
dessIndent
The method that is to onOpen just that it executes before the login on solutions with a login form (not login soliution). The default is -none-.
prs
Parameters
sIndent|String> queryParams all query parameters of the deeplink url with which the Client was started, key>string if there was one value else key>Array<String>clients
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, |)
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 started|String> queryParams all query parameters of the deeplink url with which the Client was started, key>string if there was one value else key>Array<String>clients