servoy sReturnTypes2100%height: 30px;2Return TypessWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKsWordListBLOCKservoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClientservoy sSummary12%30%58%height: 30px;3Methods SummaryvoidAdds a string of client information which gets stored on the server, and can be viewed on the Clients page of Servoy Server Administration Console.voidProduces a "beep" sound; commonly used to indicate an error or warning dialog.Close all visible windows (except main application window).voidCloses the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.voidCloses the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.voidCloses the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.voidCloses the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.voidCloses the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.Create a new form instance.Creates a new window that can be used for displaying forms.Creates a new window that can be used for displaying forms.voidRuns at method at the given delay in milliseconds.voidRuns at method at the given delay in milliseconds with the arguments given to the method.Execute a program and returns output.Execute a program and returns output.Execute a program and returns output.Execute a program and returns output.voidExecute a program in the background.voidExecute a program in the background.voidExecute a program in the background.voidExecute a program in the background.voidStop and exit application.This generates a browser function for the given function string that can be executed in the browser The resulting object can be assigned into a config/property object that is then assigned to a component The component will receive this function as a real function object.Get the active user count on the server (can be limited to current solution).This gets the currently focused active window; this can be the main application window or a modal dialog.Get the application type.Gets the count for all clients displaying the same additional information in the Clients page of Servoy Server Administration Console.Sets a UI property.Gets a string from the clipboard, null if not a string or empty.Gets the name of the current Look And Feel specified in Application Preferences.Get the name of the localhost.Get the clients' IP address.Get the names of the used client licenses (as strings in array).Get a JSLogger instance which offers an API for logging with arguments.Get a JSLogger instance which offers an API for logging with arguments.Get the media url that can be used to server a media in NGClient.Returns the name of the operating system of the client.Get all the printer names in an array.Get the screen height in pixels.Get the screen width in pixels.Returns a date object initialized on server with current date and time.Gets the HTTP server url.Get the uuid from this server instance (the same value that is shown on the admin page)Returns the name of the current solution.Get the solution release number.Get the parameters which are provided by startup.Returns a date object initialized in client with current date and time.Get a new UUID object (also known as GUID) or convert the parameter (that can be string or byte array) to an UUID object.Get a new UUID object (also known as GUID) or convert the parameter (that can be string or byte array) to an UUID object.Get a new UUID object (also known as GUID) or convert the parameter (that can be string or byte array) to an UUID object.Get a persistent user property.Get all persistent user property names.Retrieve a valuelist as array, to get real-values for display-values.Retrieve a valuelist display-value for a real-value.Get all values from a custom or database type value list as dataset (with columns displayValue,realValue).Get all the valuelist names as array.Returns the application version.Get the full version information of this solution and all its modules.Get the main application window.Get a window by window name.Returns true if the solution is running in the developer.Check if the last printpreview did print.voidOutput something on the out stream.voidOutput something on the out stream.voidOverrides one style with another.voidPlay a sound (AU file, an AIFF file, a WAV file, and a MIDI file).Sets a UI property.voidRedo last action (if possible).Refresh a global method valuelist by forcing it to call the global method.Refresh a global method valuelist by forcing it to call the global method.voidRemoves all names given to the client via the admin page.Removes a string of client information which is stored on the server and previously was added using the application.voidSets a string object in the clipboard.voidSet if numpad enter should behave like focus next.voidSet the status area value.voidSet the status area value.voidMake a toolbar visible or invisible.voidSets a user property for this client: <br> For headless clients(including Batch Processors and Authentication clients) the user property is stored in memory and will be lost upon client restart.voidIn NGClient this is stored in the locale storage of the browser, so it will be persisted over restarts as long as the user didn't clear the data.voidFill a custom type valuelist with values from array(s) or dataset.voidFill a custom type valuelist with values from array(s) or dataset.voidFill a custom type valuelist with values from array(s) or dataset.voidFill a custom type valuelist with values from array(s) or dataset.voidFill a custom type valuelist with values from array(s) or dataset.voidFill a custom type valuelist with values from array(s) or dataset.Show the calendar, returns selected date or null if canceled.Show the calendar, returns selected date or null if canceled.Show the calendar, returns selected date or null if canceled.Show the calendar, returns selected date or null if canceled.Show the colorChooser.Show the colorChooser.Show the font chooser dialog.Show the font chooser dialog.voidShow the form specified by the parameter, that can be a name (is case sensitive!) or a form object.Opens the i18n dialog so users can change translations.Opens the i18n dialog so users can change translations.Opens the i18n dialog so users can change translations.Shows an URL in a browser.Shows an URL in a browser.Shows an URL in a browser.Shows an URL in a browser.Shows an URL in a browser.voidSleep for specified time (in milliseconds).voidUndo last action (if possible).voidUpdates the UI (painting).voidUpdates the UI (painting).functionservoy sDetail2100%height:30px2Methods DetailsaddClientInfoname
addClientInfo(info)
dessIndent
Adds a string of client information which gets stored on the server,
and can be viewed on the Clients page of Servoy Server Administration Console.
The new piece of client information is added on behalf of the running
Servoy client.
This function can be called more than once, if you want to add multiple
lines of client information.
NOTE:
This function can also be used with the function <em>getClientCountForInfo</em>
to count the number of clients with matching addditional client information.
prs
Parameters
sIndentinfoA line of text to be added as additional client information on behalf of the running Servoy client.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowbeepname
beep()
dessIndent
Produces a "beep" sound; commonly used to indicate an error or warning dialog.
clients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowcloseAllWindowsname
closeAllWindows()
dessIndent
Close all visible windows (except main application window). Returns true if operation was successful.
ret
Returns
sIndent Boolean true if all windows were closed and false otherwise.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcloseSolutionname
closeSolution()
dessIndent
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
If the user has been logged in, this function keeps the user logged in and in the newly open solution, the login is skipped and the solution goes straight to the first form.
If you want to go to a different url, you need to call application.showURL(url) before calling application.closeSolution() (this is only applicable for Web Client).
An alternative option is security.logout() which also does a log out for the user (for solutions that require authentication).
clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcloseSolutionname
closeSolution(solutionToLoad)
dessIndent
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
If the user has been logged in, this function keeps the user logged in and in the newly open solution, the login is skipped and the solution goes straight to the first form.
If you want to go to a different url, you need to call application.showURL(url) before calling application.closeSolution() (this is only applicable for Web Client).
An alternative option is security.logout() which also does a log out for the user (for solutions that require authentication).
prs
Parameters
sIndentsolutionToLoadName of the solution to loadclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcloseSolutionname
closeSolution(solutionToLoad, methodArgument)
dessIndent
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
If the user has been logged in, this function keeps the user logged in and in the newly open solution, the login is skipped and the solution goes straight to the first form.
If you want to go to a different url, you need to call application.showURL(url) before calling application.closeSolution() (this is only applicable for Web Client).
An alternative option is security.logout() which also does a log out for the user (for solutions that require authentication).
prs
Parameters
sIndentsolutionToLoadName of the solution to loadmethodArgumentArgument passed to the solution onOpenclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcloseSolutionname
closeSolution(solutionToLoad, methodName)
dessIndent
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
If the user has been logged in, this function keeps the user logged in and in the newly open solution, the login is skipped and the solution goes straight to the first form.
If you want to go to a different url, you need to call application.showURL(url) before calling application.closeSolution() (this is only applicable for Web Client).
An alternative option is security.logout() which also does a log out for the user (for solutions that require authentication).
prs
Parameters
sIndentsolutionToLoadName of the solution to loadmethodNameName of the global method to callclients
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
If the user has been logged in, this function keeps the user logged in and in the newly open solution, the login is skipped and the solution goes straight to the first form.
If you want to go to a different url, you need to call application.showURL(url) before calling application.closeSolution() (this is only applicable for Web Client).
An alternative option is security.logout() which also does a log out for the user (for solutions that require authentication).
prs
Parameters
sIndentsolutionToLoadName of the solution to loadmethodNameName of the global method to callmethodArgumentArgument passed to the global methodclients
sIndentdesignFormNameName of the design formnewInstanceScriptNameName of the new form instanceret
Returns
sIndent Boolean (true) if the instance was created succesfully, (false) otherwiseclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateWindowname
createWindow(windowName, type)
dessIndent
Creates a new window that can be used for displaying forms. Initially the window is not visible.
If there is already a window with the given name, it will be closed and destroyed prior to creating the new window.
Use the form controller show() and showRecords() methods in order to show a form in this window.
prs
Parameters
sIndentwindowNamethe name of the window. Should not be null.typethe type of the window. Can be one of JSWindow.DIALOG, JSWindow.MODAL_DIALOG, JSWindow.WINDOW. (WINDOW does not work for NGClient)ret
Returns
sIndent the newly created window.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowcreateWindowname
createWindow(windowName, type, parentWindow)
dessIndent
Creates a new window that can be used for displaying forms. Initially the window is not visible.
If there is already a window with the given name, it will be closed and destroyed prior to creating the new window.
Use the form controller show() and showRecords() methods in order to show a form in this window.
prs
Parameters
sIndentwindowNamethe name of the window. Should not be null.typethe type of the window. Can be one of JSWindow.DIALOG, JSWindow.MODAL_DIALOG, JSWindow.WINDOW (WINDOW doesn't work in NGClient).parentWindowthe parent JSWindow object. If it is not specified, the current window will be used as parent. This parameter is only used by dialogs.ret
Returns
sIndent the newly created window.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowexecuteLatername
executeLater(function, delay)
dessIndent
Runs at method at the given delay in milliseconds.
This is like a simple scheduler to quickly run something after a bit of delay
prs
Parameters
sIndentfunctionThe function to calldelayThe millis that has to elapse before the function is called.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowexecuteLatername
executeLater(function, delay, arguments)
dessIndent
Runs at method at the given delay in milliseconds with the arguments given to the method.
This is like a simple scheduler to quickly run something after a bit of delay
prs
Parameters
sIndentfunctionThe function to calldelayThe millis that has to elapse before the function is called.argumentsThe arguments that are given to the function when called.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowexecuteProgramname
executeProgram(program)
dessIndent
Execute a program and returns output. Specify the cmd as you would do in a console.
prs
Parameters
sIndentprogram(fullpath) of the program to executeret
Returns
sIndent The output generated by the program execution.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowexecuteProgramname
executeProgram(program, params)
dessIndent
Execute a program and returns output. Specify the cmd as you would do in a console.
prs
Parameters
sIndentprogram(fullpath) of the program to executeparamsan array of strings as program argumentsret
Returns
sIndent The output generated by the program execution.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowexecuteProgramname
executeProgram(program, params, environmentVars)
dessIndent
Execute a program and returns output. Specify the cmd as you would do in a console.
prs
Parameters
sIndentprogram(fullpath) of the program to executeparamsan array of strings as program argumentsenvironmentVarsarray of strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.ret
Returns
sIndent The output generated by the program execution.clients
Execute a program and returns output. Specify the cmd as you would do in a console.
prs
Parameters
sIndentprogram(fullpath) of the program to executeparamsan array of strings as program argumentsenvironmentVarsarray of strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.startDirthe working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.ret
Returns
sIndent The output generated by the program execution.clients
Execute a program in the background. Specify the cmd as you would do in a console.
prs
Parameters
sIndentprogram(fullpath) of the program to executeparamsan array of strings as program argumentsenvironmentVarsarray of strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.clients
Execute a program in the background. Specify the cmd as you would do in a console.
prs
Parameters
sIndentprogram(fullpath) of the program to executeparamsan array of strings as program argumentsenvironmentVarsarray of strings, each element of which has environment variable settings in the format name=value, or null if the subprocess should inherit the environment of the current process.startDirthe working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.clients
sIndent the property value for the given name/key, null of nothing was found
currently focused active window; this can be the main application window or a modal dialog.
For a webclient getWindow() can return the main window that is not really the main for the current tab in the browser
that can return the previous tab that a user could have opened. For this method is better suited because this
will give you the actual tab in the browser. Another call would be form.controller.getWindow() of a form that you know in which window it resides.
ret
Returns
sIndent the current active/focussed window.clients
Gets the name of the current Look And Feel specified in Application Preferences.
ret
Returns
sIndent Current Look And Feelclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowgetHostNamename
getHostName()
dessIndent
Get the name of the localhost.
ret
Returns
sIndent Name of the localhostclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetIPAddressname
getIPAddress()
dessIndent
Get the clients' IP address.
ret
Returns
sIndent IP address of the clientclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetLicenseNamesname
getLicenseNames()
dessIndent
Get the names of the used client licenses (as strings in array).
ret
Returns
sIndent Client licenses namesclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetLoggername
getLogger()
dessIndent
Get a JSLogger instance which offers an API for logging with arguments.
Available logging levels are (in order): fatal, error, warn, info, debug and trace.
If no loggerName is given to this method, it returns the default logger (LoggerFactory.getLogger(Debug.class))
NOTE: the default logging level of the the default logger is 'warn', so info, debug and trace events are not logged.
JSLogger instance which offers an API for logging with arguments.
Available logging levels are (in order): fatal, error, warn, info, debug and trace.
The argument should be the name of
the current Look And Feel specified in Application Preferences.ret
Returns
sIndent Current Look And Feelclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowgetHostNamename
getHostName()
dessIndent
Get the name of the localhost.
ret
Returns
sIndent Name of the localhostclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetIPAddressname
getIPAddress()
dessIndent
Get the clients' IP address.
ret
Returns
sIndent IP address of the clientclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetLicenseNamesname
getLicenseNames()
dessIndent
Get the names of the used client licenses (as strings in array).
ret
Returns
sIndent Client licenses names
a logger that is configured in myServoyInstallationDir/application_server/log4j.xml.
A new logger can be configured in log4j.xml by adding the following line:
<Logger name="myLogger" level="INFO"/>
prs
Parameters
sIndentloggerNamethe name of the logger, as configured in log4j.xmlret
Returns
sIndent a new JSLogger instanceclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetMediaURLname
getMediaURL(mediaName)
dessIndent
Get the media url that can be used to server a media in NGClient.
prs
Parameters
sIndentmediaNameName of the mediaret
Returns
sIndentclients
Supported Clients
sIndentNGClientsam
Sample
sIdentjavascriptlastDetailRowgetOSNamename
getOSName()
dessIndent
Returns the name of the operating system of the client.
In Smart Client this will return os.name system property. In Web/NG Client will return "OSFamily majorVersion.minorVersion".
ret
Returns
sIndent Name of the operating system of the clientclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetPrintersname
getPrinters()
dessIndent
Get all the printer names in an array.
ret
Returns
sIndent All printer namesclients
Supported Clients
sIndentSmartClient,WebClientsam
Sample
sIdentjavascriptlastDetailRowgetScreenHeightname
getScreenHeight()
dessIndent
Get the screen height in pixels.
ret
Returns
sIndent Screen heightclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetScreenWidthname
getScreenWidth()
dessIndentGet the screen width in pixelsgetScreenWidthname
dessIndentReturns a date object initialized on server with current date and time.
For NG and web clients this is the same as new Date() in scripting.ret
Returns
sIndent Server timeclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetServerURLname
getServerURL()
dessIndentGets the HTTP server url
Gets the HTTP server url.
This url will end with a / so don't append to this server url something that starts with a / again
because RFC 3986 says that the path of a url (the part after the domain[:poort]) can not start with 2 slashes.
Get the parameters which are provided by startup.
It returns an array with 2 elements, a string that is the startup argument and a map containing all named startup arguments, or
null if there is no argument passed
ret
Returns
sIndent Array with 2 elements, a string that is the startup argument and a map containing all named startup arguments, or null if there is no argument passedclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetTimeStampname
getTimeStamp()
dessIndent
Returns a date object initialized in client with current date and time.
This should be used instead of new Date() for webclients when the clients are in different times zones then the server.
Then this call will really return a time that is the locals webclients time.
For NG clients this is only useful when displaying on the client using format property (Use local time), and then
this is equivalent to new Date() on the client side, so basically this can be used to pre-fill with 'now' such a display.
ret
Returns
sIndent Current time at the clientclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetUUIDname
getUUID()
dessIndent
Get a new UUID object (also known as GUID) or convert the parameter (that can be string or byte array) to an UUID object. A table column marked as UUID will work with such objects.
ret
Returns
sIndent The new UUID objectclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetUUIDname
getUUID(byteArray)
dessIndent
Get a new UUID object (also known as GUID) or convert the parameter (that can be string or byte array) to an UUID object. A table column marked as UUID will work with such objects.
prs
Parameters
sIndentbyteArrayByte array representing an uuidret
Returns
sIndent The new UUID objectclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetUUIDname
getUUID(uuidString)
dessIndent
Get a new UUID object (also known as GUID) or convert the parameter (that can be string or byte array) to an UUID object. A table column marked as UUID will work with such objects.
prs
Parameters
sIndentuuidStringString representing an uuidret
Returns
sIndent The new UUID objectclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetUserPropertyname
getUserProperty(name)
dessIndentGet a persistent user property,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetUserPropertyname
getUserProperty(name)
dessIndent
Get a persistent user property.
In NGClient this is stored in the locale storage of the browser, so it will be persisted over restarts as long as the user didn't clear the data.
Retrieve a valuelist as array, to get real-values for display-values.
NOTE: this doesn't return a value for a valuelist that depends on a database relation or is a global method valuelist.
Retrieve a valuelist display-value for a real-value.
NOTE: this doesn't return a value for a valuelist that depends on a database relation or is a global method valuelist.
prs
Parameters
sIndentnameName of the valuelistrealValueReal value of the valuelistret
Returns
sIndent Display value of the real value from the valuelistclients
Get all values from a custom or database type value list as dataset (with columns displayValue,realValue).
NOTE: this doesn't return a value for a valuelist that depends on a database relation or is a global method valuelist.
prs
Parameters
sIndentnameName of the valuelistret
Returns
sIndent DataSet with valuelist's display values and real valuesclients
Get the full version information of this solution and all its modules.
This will return an object that is a map of Name(Sting)->Version(String) of the solution and all its modules.
ret
Returns
sIndent Name->Version map object.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetWindowname
getWindow()
dessIndent
Get the main application window. This is the window that is created first for this client.
In a smart client this is always just the first started window where the solution is loaded in.
In a webclient the user may open the same solution in a new tab in the same browser. In that case the main solution
window will always be the first opened tab, even if that one was already closed.
application.getActiveWindow() will always return the currently active/focused window or dialog.
If you need the window of the current top-level form, controller.getWindow() of that form will
always return the correct window.
ret
Returns
sIndent the main application JSWindow.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowgetWindowname
getWindow(name)
dessIndent
Get a window by window name. When not supplying a name, the main application window is grabbed.
prs
Parameters
sIndentnamethe name of the window. If not specified, the main application JSWindow will be returned.ret
Returns
sIndent the JSWindow with the specified name, or null if no such window exists.clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowisInDevelopername
isInDeveloper()
dessIndent
Returns true if the solution is running in the developer.
ret
Returns
sIndent Boolean (true) if the solution is running in the developer, (false) otherwiseclients
Refresh a global method valuelist by forcing it to call the global method. The element which has the valuelist must be provided.
If there is no propertyName specified, the element must have only one valuelist property.
prs
Parameters
sIndentelementform elementret
Returns
sIndent boolean indicating if valuelist was refreshedclients
Refresh a global method valuelist by forcing it to call the global method. The element which has the valuelist must be provided.
The valuelist is searched under provided property from the spec - for usage in NGClient custom components.
prs
Parameters
sIndentelementform elementpropertyNamename of property from the specret
Returns
sIndent boolean indicating if valuelist was refreshedclients
Removes all names given to the client via the admin page.
clients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowremoveClientInfoname
removeClientInfo(info)
dessIndent
Removes a string of client information which is stored on the server and
previously was added using the application.addClientInfo('client info')
This function can be called more than once, if you want to delete multiple
lines of client information.
prs
Parameters
sIndentinfoA line of text to be removed from the client information on behalf of the running Servoy client.ret
Returns
sIndent boolean indicator if info was removed successfullyclients
Set if numpad enter should behave like focus next.
prs
Parameters
sIndentenabledBoolean (true) if numpad enter should behave like focus nextclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowsetStatusTextname
setStatusText(text)
dessIndent
Set the status area value.
prs
Parameters
sIndenttextNew status textclients
Supported Clients
sIndentSmartClient,WebClientsam
Sample
sIdentjavascriptlastDetailRowsetStatusTextname
setStatusText(text, tooltip)
dessIndent
Set the status area value.
NOTE: Most modern browsers do not support status bar and status text anymore. This method sets status property of the window using javascript.
prs
Parameters
sIndenttextNew status texttooltipStatus tooltip textclients
sIndentnameName of the toolbarvisibleVisibility of the toolbarclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowsetUserPropertyname
setUserProperty(name, value)
dessIndent
Sets a user property for this client:
In NGClient this is stored in the locale storage of the browser, so it will be persisted over restarts as long as the user didn't clear the data.
For headless clients(including Batch Processors and Authentication clients) the user property is stored in memory and will be lost upon client restart.
For Web Client the user property will be stored in a persistent cookie
For Smart Client it will be stored in a properties file on the client machine.
prs
Parameters
sIndentnameName of the user propertyvalueNew value of the user propertyclients
Fill a custom type valuelist with values from array(s) or dataset.
NOTE: if you modify values for checkbox/radio field, note that having one value in valuelist is a special case, so switching between one value and 0/multiple values may have side effects
NOTE: This is expensive operation, which triggers refresh of all visible forms. Over usage of this method may inflict performance issues.
prs
Parameters
sIndentnameName of the valuelistdatasetDataset with display/real valuesclients
Fill a custom type valuelist with values from array(s) or dataset.
NOTE: if you modify values for checkbox/radio field, note that having one value in valuelist is a special case, so switching between one value and 0/multiple values may have side effects
NOTE: This is expensive operation, which triggers refresh of all visible forms. Over usage of this method may inflict performance issues.
prs
Parameters
sIndentnameName of the valuelistdatasetDataset with display/real valuesautoconvertBoolean (true) if display values and return values should be converted to numbersclients
Fill a custom type valuelist with values from array(s) or dataset.
NOTE: if you modify values for checkbox/radio field, note that having one value in valuelist is a special case, so switching between one value and 0/multiple values may have side effects
NOTE: This is expensive operation, which triggers refresh of all visible forms. Over usage of this method may inflict performance issues.
prs
Parameters
sIndentnameName of the valuelistdisplayValuesDisplay values arrayclients
Fill a custom type valuelist with values from array(s) or dataset.
NOTE: if you modify values for checkbox/radio field, note that having one value in valuelist is a special case, so switching between one value and 0/multiple values may have side effects
NOTE: This is expensive operation, which triggers refresh of all visible forms. Over usage of this method may inflict performance issues.
prs
Parameters
sIndentnameName of the valuelistdisplayValuesDisplay values arrayautoconvertBoolean (true) if display values and return values should be converted to numbersclients
Fill a custom type valuelist with values from array(s) or dataset.
NOTE: if you modify values for checkbox/radio field, note that having one value in valuelist is a special case, so switching between one value and 0/multiple values may have side effects
NOTE: This is expensive operation, which triggers refresh of all visible forms. Over usage of this method may inflict performance issues.
prs
Parameters
sIndentnameName of the valuelistdisplayValuesDisplay values arrayrealValuesReal values arrayclients
Fill a custom type valuelist with values from array(s) or dataset.
NOTE: if you modify values for checkbox/radio field, note that having one value in valuelist is a special case, so switching between one value and 0/multiple values may have side effects
NOTE: This is expensive operation, which triggers refresh of all visible forms. Over usage of this method may inflict performance issues.
prs
Parameters
sIndentname;displayValuesDisplay values arrayrealValuesReal values arrayautoconvertBoolean (true) if display values and return values should be converted to numbersclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowshowCalendarname
showCalendar()
dessIndent
Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.
ret
Returns
sIndent Selected date or null if canceledclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowshowCalendarname
showCalendar(dateFormat)
dessIndent
Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.
prs
Parameters
sIndentdateFormatDate formatret
Returns
sIndent Selected date or null if canceledclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowshowCalendarname
showCalendar(selectedDate)
dessIndent
Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.
prs
Parameters
sIndentselectedDateDefault selected dateret
Returns
sIndent Selected date or null if canceledclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowshowCalendarname
showCalendar(selectedDate, dateFormat)
dessIndent
Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.
Show the colorChooser. Returned value is in format #RRGGBB or null if canceled.
ret
Returns
sIndent selected color or null if canceledclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowshowColorChoosername
showColorChooser(colorString)
dessIndent
Show the colorChooser. Returned value is in format #RRGGBB or null if canceled.
prs
Parameters
sIndentcolorStringDefault colorret
Returns
sIndent selected color or null if canceledclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowshowFontChoosername
showFontChooser()
dessIndent
Show the font chooser dialog. Returns the selected font. Can specify a default font.
ret
Returns
sIndent selected fontclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowshowFontChoosername
showFontChooser(defaultFont)
dessIndent
Show the font chooser dialog. Returns the selected font. Can specify a default font.
prs
Parameters
sIndentdefaultFontDefault fontret
Returns
sIndent selected fontclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowshowFormname
showForm(form)
dessIndent
Show the form specified by the parameter, that can be a name (is case sensitive!) or a form object.
This will show the form in the active/currently focused window. So when called from a form in a dialog the dialog will show the form.
prs
Parameters
sIndentformForm object or nameclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowshowI18NDialogname
showI18NDialog()
dessIndent
Opens the i18n dialog so users can change translations. Returns the key selected by the user (not it's translation) or null if cancel is pressed. Optional parameters specify the initial selections in the dialog.
ret
Returns
sIndent selected I18N key or null if cancel is pressedclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowshowI18NDialogname
showI18NDialog(keyToSelect)
dessIndent
Opens the i18n dialog so users can change translations. Returns the key selected by the user (not it's translation) or null if cancel is pressed. Optional parameters specify the initial selections in the dialog.
prs
Parameters
sIndentkeyToSelectDefault selected keyret
Returns
sIndent selected I18N key or null if cancel is pressedclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowshowI18NDialogname
showI18NDialog(keyToSelect, languageToSelect)
dessIndent
Opens the i18n dialog so users can change translations. Returns the key selected by the user (not it's translation) or null if cancel is pressed. Optional parameters specify the initial selections in the dialog.
sIndent selected I18N key or null if cancel is pressedclients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowshowURLname
showURL(url)
dessIndent
Shows an URL in a browser.
prs
Parameters
sIndenturlURL to showret
Returns
sIndent Boolean (true) if URL was shownclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowshowURLname
showURL(url, browserTarget)
dessIndent
Shows an URL in a browser.
prs
Parameters
sIndenturlURL to showbrowserTargetTarget frame or named dialog/windowret
Returns
sIndent Boolean (true) if URL was shownclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowshowURLname
showURL(url, browserTarget, timeout)
dessIndent
Shows an URL in a browser.
prs
Parameters
sIndenturlURL to showbrowserTargetTarget frame or named dialog/windowtimeoutA timeout in seconds when the url should be shownret
Returns
sIndent Boolean (true) if URL was shownclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowshowURLname
showURL(url, browserTarget, browserTargetOptions)
dessIndent
Shows an URL in a browser.
prs
Parameters
sIndenturlURL to showbrowserTargetTarget frame or named dialog/windowbrowserTargetOptionsDialog options used when a dialog is specified / a timeout in seconds when the url should be shownret
sIndenturlURL to showbrowserTargetTarget frame or named dialog/windowbrowserTargetOptionsDialog options used when a dialog is specified / a timeout in seconds when the url should be showntimeoutA timeout in seconds when the url should be shownret
Returns
sIndent Boolean (true) if URL was shownclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowsleepname
sleep(ms)
dessIndent
Sleep for specified time (in milliseconds).
prs
Parameters
sIndentmsSleep time in millisecondsclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowundoname
undo()
dessIndent
Undo last action (if possible).
clients
Supported Clients
sIndentSmartClientsam
Sample
sIdentjavascriptlastDetailRowupdateUIname
updateUI()
dessIndent
Updates the UI (painting). If in a script an element changed and the script continues doing
things, you can give an number in ms how long this can take.
Warning: this gives the UI time to paint, but this also means that it will give the ui time to respond to all other events,
so if a user keeps clicking on other stuff this will also be handled right away inside this call.
NOTE:In NGClient, this method will send to browser all outstanding changes. If called too often (with many changes), can cause performance issues.
clients
Supported Clients
sIndentSmartClient,NGClientsam
Sample
sIdentjavascriptlastDetailRowupdateUIname
updateUI(milliseconds)
dessIndent
Updates the UI (painting). If in a script an element changed and the script continues doing
things, you can give an number in ms how long this can take.
Warning: this gives the UI time to paint, but this also means that it will give the ui time to respond to all other events,
so if a user keeps clicking on other stuff this will also be handled right away inside this call.
NOTE:In NGClient, this method will send to browser all outstanding changes. If called too often (with many changes), can cause performance issues.
prs
Parameters
sIndentmillisecondsHow long the update should take in millisecondsclients