Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
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 sReturnTypes
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Return Types
Table Row (tr)
Table Cell (td)
Span
classsWordList
DRAGNDROP
Span
classsWordList
JSDNDEvent
Span
classsWordList
JSEvent
Span
classsWordList
JSRenderEvent
Span
classsWordList
JSWindow
Span
classsWordList
APPLICATION_TYPES
Span
classsWordList
CLIENTDESIGN
Span
classsWordList
ELEMENT_TYPES
Span
classsWordList
LOGGINGLEVEL
Span
classsWordList
UICONSTANTS
Span
classsWordList
WEBCONSTANTS
Span
classsWordList
Renderable
Span
classsWordList
UUID



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
addClientInfo(info)
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.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
beep()
Produces a "beep" sound; commonly used to indicate an error or warning dialog.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
closeAllWindows()
Close all visible windows (except main application window).
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
closeSolution()
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
closeSolution(solutionToLoad)
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
closeSolution(solutionToLoad, methodName)
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
closeSolution(solutionToLoad, methodName, methodArgument)
Closes the currently open solution and optionally opens another solution, calling a specified global method with the specified arguments.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
createNewFormInstance(designFormName, newInstanceScriptName)
Create a new form instance.
Table Row (tr)
Table Cell (td)
JSWindow
Table Cell (td)
createWindow(windowName, type)
Creates a new window that can be used for displaying forms.
Table Row (tr)
Table Cell (td)
JSWindow
Table Cell (td)
createWindow(windowName, type, parentWindow)
Creates a new window that can be used for displaying forms.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
executeProgram(program)
Execute a program and returns output.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
executeProgram(program, params)
Execute a program and returns output.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
executeProgram(program, params, environmentVars)
Execute a program and returns output.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
executeProgram(program, params, environmentVars, startDir)
Execute a program and returns output.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
executeProgramInBackground(program)
Execute a program in the background.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
executeProgramInBackground(program, params)
Execute a program in the background.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
executeProgramInBackground(program, params, environmentVars)
Execute a program in the background.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
executeProgramInBackground(program, params, environmentVars, startDir)
Execute a program in the background.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
exit()
Stop and exit application.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getActiveClientCount(currentSolutionOnly)
Get the active user count on the server (can be limited to current solution).
Table Row (tr)
Table Cell (td)
JSWindow
Table Cell (td)
getActiveWindow()
This gets the currently focused active window; this can be the main application window or a modal dialog.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getApplicationType()
Get the application type.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getClientCountForInfo(info)
Gets the count for all clients displaying the same additional information
in the Clients page of Servoy Server Administration Console.
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
getClientProperty(name)
Sets a UI property.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getClipboardString()
Gets a string from the clipboard, null if not a string or empty.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getCurrentLookAndFeelName()
Gets the name of the current Look And Feel specified in Application Preferences.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getHostName()
Get the name of the localhost.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getIPAddress()
Get the clients' IP address.
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
getLicenseNames()
Get the names of the used client licenses (as strings in array).
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getOSName()
Returns the name of the operating system.
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
getPrinters()
Get all the printer names in an array.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getScreenHeight()
Get the screen height in pixels.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getScreenWidth()
Get the screen width in pixels.
Table Row (tr)
Table Cell (td)
Date
Table Cell (td)
getServerTimeStamp()
Returns a date object initialized on server with current date and time.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getServerURL()
Gets the HTTP server url.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getSolutionName()
Returns the name of the current solution.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getSolutionRelease()
Get the solution release number.
Table Row (tr)
Table Cell (td)
Date
Table Cell (td)
getTimeStamp()
Returns a date object initialized in client with current date and time.
Table Row (tr)
Table Cell (td)
UUID
Table Cell (td)
getUUID()
Get a new UUID object (also known as GUID) or convert the parameter (that can be string or byte array) to an UUID object.
Table Row (tr)
Table Cell (td)
UUID
Table Cell (td)
getUUID(byteArray)
Get a new UUID object (also known as GUID) or convert the parameter (that can be string or byte array) to an UUID object.
Table Row (tr)
Table Cell (td)
UUID
Table Cell (td)
getUUID(uuidString)
Get a new UUID object (also known as GUID) or convert the parameter (that can be string or byte array) to an UUID object.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getUserProperty(name)
Get a persistent user property.
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
getUserPropertyNames()
Get all persistent user property names.
Table Row (tr)
Table Cell (td)
Array
Table Cell (td)
getValueListArray(name)
Retrieve a valuelist as array, to get real-values for display-values.
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
getValueListDisplayValue(name, realValue)
Retrieve a valuelist display-value for a real-value.
Table Row (tr)
Table Cell (td)
JSDataSet
Table Cell (td)
getValueListItems(name)
Get all values from a custom or database type value list as dataset (with columns displayValue,realValue).
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
getValueListNames()
Get all the valuelist names as array.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getVersion()
Returns the application version.
Table Row (tr)
Table Cell (td)
JSWindow
Table Cell (td)
getWindow()
Get the main application window.
Table Row (tr)
Table Cell (td)
JSWindow
Table Cell (td)
getWindow(name)
Get a window by window name.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
isInDeveloper()
Returns true if the solution is running in the developer.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
isLastPrintPreviewPrinted()
Check if the last printpreview did print.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
output(msg)
Output something on the out stream.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
output(msg, level)
Output something on the out stream.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
overrideStyle(originalStyleName, newStyleName)
Overrides one style (defined in in a form) with another.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
playSound(url)
Play a sound (AU file, an AIFF file, a WAV file, and a MIDI file).
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
putClientProperty(name, value)
Sets a UI property.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
redo()
Redo last action (if possible).
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
removeAllClientInfo()
Removes all names given to the client via the admin page.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeClientInfo(info)
Removes a string of client information which is stored on the server and
previously was added using the application.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setClipboardContent(string)
Sets a string object in the clipboard.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setNumpadEnterAsFocusNextEnabled(enabled)
Set if numpad enter should behave like focus next.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setStatusText(text)
Set the status area value.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setStatusText(text, tooltip)
Set the status area value.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setToolbarVisible(name, visible)
Make a toolbar visible or invisible.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setUserProperty(name, value)
Sets a user property for this client: <br>
For heedless clients((including Batch Processors and Authentication clients) the user property is stored in memory and will be lost upon client restart.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setValueListItems(name, dataset)
Fill a custom type valuelist with values from array(s) or dataset.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setValueListItems(name, dataset, autoconvert)
Fill a custom type valuelist with values from array(s) or dataset.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setValueListItems(name, displayValues)
Fill a custom type valuelist with values from array(s) or dataset.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setValueListItems(name, displayValues, autoconvert)
Fill a custom type valuelist with values from array(s) or dataset.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setValueListItems(name, displayValues, realValues)
Fill a custom type valuelist with values from array(s) or dataset.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setValueListItems(name, displayValues, realValues, autoconvert)
Fill a custom type valuelist with values from array(s) or dataset.
Table Row (tr)
Table Cell (td)
Date
Table Cell (td)
showCalendar()
Show the calendar, returns selected date or null if canceled.
Table Row (tr)
Table Cell (td)
Date
Table Cell (td)
showCalendar(dateFormat)
Show the calendar, returns selected date or null if canceled.
Table Row (tr)
Table Cell (td)
Date
Table Cell (td)
showCalendar(selectedDate)
Show the calendar, returns selected date or null if canceled.
Table Row (tr)
Table Cell (td)
Date
Table Cell (td)
showCalendar(selectedDate, dateFormat)
Show the calendar, returns selected date or null if canceled.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
showColorChooser()
Show the colorChooser.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
showColorChooser(colorString)
Show the colorChooser.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
showFontChooser()
Show the font chooser dialog.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
showFontChooser(defaultFont)
Show the font chooser dialog.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showForm(form)
Show the form specified by the parameter, that can be a name (is case sensitive!) or a form object.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
showI18NDialog()
Opens the i18n dialog so users can change translations.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
showI18NDialog(keyToSelect)
Opens the i18n dialog so users can change translations.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
showI18NDialog(keyToSelect, languageToSelect)
Opens the i18n dialog so users can change translations.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
showURL(url)
Shows an URL in a browser.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
showURL(url, webclientTarget)
Shows an URL in a browser.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
showURL(url, webclientTarget, timeout)
Shows an URL in a browser.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
showURL(url, webclientTarget, webclientTargetOptions)
Shows an URL in a browser.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
showURL(url, webclientTarget, webclientTargetOptions, timeout)
Shows an URL in a browser.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
sleep(ms)
Sleep for specified time (in milliseconds).
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
undo()
Undo last action (if possible).
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
updateUI()
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
updateUI(milliseconds)



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idaddClientInfo-String
Table Row (tr)
idname
Table Cell (td)

addClientInfo

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
addClientInfo
Span
(info)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} info - A line of text to be added as additional client information
on behalf of the running Servoy client.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.addClientInfo('SaaS company name');
application.addClientInfo('For any issues call +31-SA-AS');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idbeep
Table Row (tr)
idname
Table Cell (td)

beep

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
beep
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Produces a "beep" sound; commonly used to indicate an error or warning dialog.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.beep();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcloseAllWindows
Table Row (tr)
idname
Table Cell (td)

closeAllWindows

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
closeAllWindows
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Close all visible windows (except main application window). Returns true if operation was successful.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - Boolean true if all windows were closed and false otherwise.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var win = application.createWindow("aWindowName", JSWindow.WINDOW, null);
win.setInitialBounds(10, 10, 300, 300);
win.title = "This is a window";
controller.show(win);

var win2 = application.createWindow("anotherWindowName", JSWindow.WINDOW, null);
win2.setInitialBounds(100, 100, 300, 300);
win2.title = "This is another window";
controller.show(win2);

var qdialog = plugins.dialogs.showQuestionDialog("QuestionDialog","Do you want to close the windows?","Yes","No");
if (qdialog == "Yes") {
	application.closeAllWindows();
	controller.show(null);
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcloseSolution
Table Row (tr)
idname
Table Cell (td)

closeSolution

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
closeSolution
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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).
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//application.showURL('http://www.servoy.com', '_self');  //Web Client only
application.closeSolution();
//close current solution, open solution 'solution_name', call global method 'global_method_name' with argument 'my_argument'.
//if the user has been logged in, he will stay logged in
//application.closeSolution('solution_name','global_method_name','my_argument');
//Note: specifying a solution will not work in the Developer due to debugger dependencies
//specified solution should be of compatible type with client (normal type or client specific(Smart client only/Web client only) type )
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcloseSolution-String
Table Row (tr)
idname
Table Cell (td)

closeSolution

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
closeSolution
Span
(solutionToLoad)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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).
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} solutionToLoad - Name of the solution to load
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//application.showURL('http://www.servoy.com', '_self');  //Web Client only
application.closeSolution();
//close current solution, open solution 'solution_name', call global method 'global_method_name' with argument 'my_argument'.
//if the user has been logged in, he will stay logged in
//application.closeSolution('solution_name','global_method_name','my_argument');
//Note: specifying a solution will not work in the Developer due to debugger dependencies
//specified solution should be of compatible type with client (normal type or client specific(Smart client only/Web client only) type )
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcloseSolution-String_String
Table Row (tr)
idname
Table Cell (td)

closeSolution

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
closeSolution
Span
(solutionToLoad, methodName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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).
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} solutionToLoad - Name of the solution to load
{String} methodName - Name of the global method to call
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//application.showURL('http://www.servoy.com', '_self');  //Web Client only
application.closeSolution();
//close current solution, open solution 'solution_name', call global method 'global_method_name' with argument 'my_argument'.
//if the user has been logged in, he will stay logged in
//application.closeSolution('solution_name','global_method_name','my_argument');
//Note: specifying a solution will not work in the Developer due to debugger dependencies
//specified solution should be of compatible type with client (normal type or client specific(Smart client only/Web client only) type )
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcloseSolution-String_String_Object
Table Row (tr)
idname
Table Cell (td)

closeSolution

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
closeSolution
Span
(solutionToLoad, methodName, methodArgument)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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).
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} solutionToLoad - Name of the solution to load
{String} methodName - Name of the global method to call
{Object} methodArgument - Argument passed to the global method
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//application.showURL('http://www.servoy.com', '_self');  //Web Client only
application.closeSolution();
//close current solution, open solution 'solution_name', call global method 'global_method_name' with argument 'my_argument'.
//if the user has been logged in, he will stay logged in
//application.closeSolution('solution_name','global_method_name','my_argument');
//Note: specifying a solution will not work in the Developer due to debugger dependencies
//specified solution should be of compatible type with client (normal type or client specific(Smart client only/Web client only) type )
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateNewFormInstance-String_String
Table Row (tr)
idname
Table Cell (td)

createNewFormInstance

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
createNewFormInstance
Span
(designFormName, newInstanceScriptName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Create a new form instance.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} designFormName - Name of the design form
{String} newInstanceScriptName - Name of the new form instance
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - Boolean (true) if the instance was created succesfully, (false) otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var ok = application.createNewFormInstance('orders','orders_view');
if (ok)
{
	var dialog = application.createWindow("myDialog", JSWindow.DIALOG);
 dialog.show('orders_view')
	//forms['orders_view'].controller.show()
	//forms.xyz.elements.myTabPanel.addTab(forms['orders_view'])
	//forms['orders_view'].elements.mylabel.setLocation(10,20)
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateWindow-String_Number
Table Row (tr)
idname
Table Cell (td)

createWindow

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSWindow
Span
stylefont-weight: bold;
createWindow
Span
(windowName, type)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} windowName - the name of the window.
{Number} type - the type of the window. Can be one of JSWindow.DIALOG, JSWindow.MODAL_DIALOG, JSWindow.WINDOW.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSWindow - the newly created window.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// create and show a window, with specified title, initial location and size
// type of the window can be one of JSWindow.DIALOG, JSWindow.MODAL_DIALOG, JSWindow.WINDOW
// If parentWindow is not specified, the current window will be used as parent; parentWindow parameter is only used by dialogs
var win = application.createWindow("windowName", JSWindow.WINDOW);
win.setInitialBounds(10, 10, 300, 300);
win.title = "This is a window";
controller.show(win);
// create and show a non-modal dialog with default initial bounds/title
var nmd = application.createWindow("nonModalDialogName", JSWindow.DIALOG);
controller.showRecords(15, nmd); // 15 is a single-number pk in this case
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcreateWindow-String_Number_JSWindow
Table Row (tr)
idname
Table Cell (td)

createWindow

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSWindow
Span
stylefont-weight: bold;
createWindow
Span
(windowName, type, parentWindow)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} windowName - the name of the window.
{Number} type - the type of the window. Can be one of JSWindow.DIALOG, JSWindow.MODAL_DIALOG, JSWindow.WINDOW.
{JSWindow} parentWindow - the parent JSWindow object. If it is not specified, the current window will be used as parent. This parameter is only used by dialogs.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSWindow - the newly created window.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// create and show a window, with specified title, initial location and size
var win = application.createWindow("windowName", JSWindow.WINDOW);
win.setInitialBounds(10, 10, 300, 300);
win.title = "This is a window";
controller.show(win);
// create and show a non-modal dialog with default initial bounds/title
var nmd = application.createWindow("nonModalDialogName", JSWindow.DIALOG);
controller.showRecords(15, nmd); // 15 is a single-number pk in this case
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexecuteProgram-String
Table Row (tr)
idname
Table Cell (td)

executeProgram

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
executeProgram
Span
(program)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute a program and returns output. Specify the cmd as you would do in a console.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} program - (fullpath) of the program to execute
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - The output generated by the program execution.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// For Windows systems:
// Runs a binary located in the user's home directory. The application will run in the current working
// directory, which in general is the one where Servoy was started from.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]);
// The same as above, but run the application in the user's home directory.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\");
// The same as above, but also set an environment variable for the called program.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\");
// For non-Windows systems:
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"]);
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/");
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/");
// Open a file with the default application associated with it. (on Windows)
application.executeProgram("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]);
// Open a file with the default application associated with it. (on Linux)
application.executeProgram("xdg-open", ["filename"]);
// Open a file with the default application associated with it. (on MacOS)
application.executeProgram("open", ["filename"]);
// Open a file with a specific application (on MacOS).
application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexecuteProgram-String_StringArray
Table Row (tr)
idname
Table Cell (td)

executeProgram

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
executeProgram
Span
(program, params)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute a program and returns output. Specify the cmd as you would do in a console.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} program - (fullpath) of the program to execute
{String[]} params - an array of strings as program arguments
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - The output generated by the program execution.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// For Windows systems:
// Runs a binary located in the user's home directory. The application will run in the current working
// directory, which in general is the one where Servoy was started from.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]);
// The same as above, but run the application in the user's home directory.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\");
// The same as above, but also set an environment variable for the called program.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\");
// For non-Windows systems:
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"]);
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/");
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/");
// Open a file with the default application associated with it. (on Windows)
application.executeProgram("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]);
// Open a file with the default application associated with it. (on Linux)
application.executeProgram("xdg-open", ["filename"]);
// Open a file with the default application associated with it. (on MacOS)
application.executeProgram("open", ["filename"]);
// Open a file with a specific application (on MacOS).
application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexecuteProgram-String_StringArray_StringArray
Table Row (tr)
idname
Table Cell (td)

executeProgram

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
executeProgram
Span
(program, params, environmentVars)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute a program and returns output. Specify the cmd as you would do in a console.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} program - (fullpath) of the program to execute
{String[]} params - an array of strings as program arguments
{String[]} environmentVars - array 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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - The output generated by the program execution.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// For Windows systems:
// Runs a binary located in the user's home directory. The application will run in the current working
// directory, which in general is the one where Servoy was started from.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]);
// The same as above, but run the application in the user's home directory.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\");
// The same as above, but also set an environment variable for the called program.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\");
// For non-Windows systems:
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"]);
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/");
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/");
// Open a file with the default application associated with it. (on Windows)
application.executeProgram("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]);
// Open a file with the default application associated with it. (on Linux)
application.executeProgram("xdg-open", ["filename"]);
// Open a file with the default application associated with it. (on MacOS)
application.executeProgram("open", ["filename"]);
// Open a file with a specific application (on MacOS).
application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexecuteProgram-String_StringArray_StringArray_String
Table Row (tr)
idname
Table Cell (td)

executeProgram

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
executeProgram
Span
(program, params, environmentVars, startDir)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute a program and returns output. Specify the cmd as you would do in a console.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} program - (fullpath) of the program to execute
{String[]} params - an array of strings as program arguments
{String[]} environmentVars - array 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.
{String} startDir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - The output generated by the program execution.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// For Windows systems:
// Runs a binary located in the user's home directory. The application will run in the current working
// directory, which in general is the one where Servoy was started from.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]);
// The same as above, but run the application in the user's home directory.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\");
// The same as above, but also set an environment variable for the called program.
application.executeProgram("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\");
// For non-Windows systems:
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"]);
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/");
application.executeProgram("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/");
// Open a file with the default application associated with it. (on Windows)
application.executeProgram("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]);
// Open a file with the default application associated with it. (on Linux)
application.executeProgram("xdg-open", ["filename"]);
// Open a file with the default application associated with it. (on MacOS)
application.executeProgram("open", ["filename"]);
// Open a file with a specific application (on MacOS).
application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexecuteProgramInBackground-String
Table Row (tr)
idname
Table Cell (td)

executeProgramInBackground

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
executeProgramInBackground
Span
(program)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute a program in the background. Specify the cmd as you would do in a console.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} program - (fullpath) of the program to execute
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// For Windows systems:
// Runs a binary located in the user's home directory. The application will run in the current working
// directory, which in general is the one where Servoy was started from.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]);
// The same as above, but run the application in the user's home directory.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\");
// The same as above, but also set an environment variable for the called program.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\");
// For non-Windows systems:
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"]);
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/");
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/");
// Open a file with the default application associated with it. (on Windows)
application.executeProgramInBackground("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]);
// Open a file with the default application associated with it. (on Linux)
application.executeProgramInBackground("xdg-open", ["filename"]);
// Open a file with the default application associated with it. (on MacOS)
application.executeProgramInBackground("open", ["filename"]);
// Open a file with a specific application (on MacOS).
application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexecuteProgramInBackground-String_StringArray
Table Row (tr)
idname
Table Cell (td)

executeProgramInBackground

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
executeProgramInBackground
Span
(program, params)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute a program in the background. Specify the cmd as you would do in a console.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} program - (fullpath) of the program to execute
{String[]} params - an array of strings as program arguments
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// For Windows systems:
// Runs a binary located in the user's home directory. The application will run in the current working
// directory, which in general is the one where Servoy was started from.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]);
// The same as above, but run the application in the user's home directory.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\");
// The same as above, but also set an environment variable for the called program.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\");
// For non-Windows systems:
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"]);
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/");
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/");
// Open a file with the default application associated with it. (on Windows)
application.executeProgramInBackground("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]);
// Open a file with the default application associated with it. (on Linux)
application.executeProgramInBackground("xdg-open", ["filename"]);
// Open a file with the default application associated with it. (on MacOS)
application.executeProgramInBackground("open", ["filename"]);
// Open a file with a specific application (on MacOS).
application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexecuteProgramInBackground-String_StringArray_StringArray
Table Row (tr)
idname
Table Cell (td)

executeProgramInBackground

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
executeProgramInBackground
Span
(program, params, environmentVars)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute a program in the background. Specify the cmd as you would do in a console.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} program - (fullpath) of the program to execute
{String[]} params - an array of strings as program arguments
{String[]} environmentVars - array 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.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// For Windows systems:
// Runs a binary located in the user's home directory. The application will run in the current working
// directory, which in general is the one where Servoy was started from.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]);
// The same as above, but run the application in the user's home directory.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\");
// The same as above, but also set an environment variable for the called program.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\");
// For non-Windows systems:
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"]);
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/");
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/");
// Open a file with the default application associated with it. (on Windows)
application.executeProgramInBackground("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]);
// Open a file with the default application associated with it. (on Linux)
application.executeProgramInBackground("xdg-open", ["filename"]);
// Open a file with the default application associated with it. (on MacOS)
application.executeProgramInBackground("open", ["filename"]);
// Open a file with a specific application (on MacOS).
application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexecuteProgramInBackground-String_StringArray_StringArray_String
Table Row (tr)
idname
Table Cell (td)

executeProgramInBackground

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
executeProgramInBackground
Span
(program, params, environmentVars, startDir)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Execute a program in the background. Specify the cmd as you would do in a console.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} program - (fullpath) of the program to execute
{String[]} params - an array of strings as program arguments
{String[]} environmentVars - array 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.
{String} startDir - the working directory of the subprocess, or null if the subprocess should inherit the working directory of the current process.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// For Windows systems:
// Runs a binary located in the user's home directory. The application will run in the current working
// directory, which in general is the one where Servoy was started from.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"]);
// The same as above, but run the application in the user's home directory.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], null, "c:\\Users\\myself\\");
// The same as above, but also set an environment variable for the called program.
application.executeProgramInBackground("c:\\Users\\myself\\myapp.exe", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "c:\\Users\\myself\\");
// For non-Windows systems:
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"]);
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], null, "/home/myself/");
application.executeProgramInBackground("/home/myself/myapp", ["arg1", "arg2", "arg3"], ["MY_ENV_VAR=something"], "/home/myself/");
// Open a file with the default application associated with it. (on Windows)
application.executeProgramInBackground("rundll32.exe", ["url.dll,FileProtocolHandler", "filename"]);
// Open a file with the default application associated with it. (on Linux)
application.executeProgramInBackground("xdg-open", ["filename"]);
// Open a file with the default application associated with it. (on MacOS)
application.executeProgramInBackground("open", ["filename"]);
// Open a file with a specific application (on MacOS).
application.executeProgram("open", ["-a", "OpenOffice.org.app", "filename.doc"]);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idexit
Table Row (tr)
idname
Table Cell (td)

exit

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
exit
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Stop and exit application.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// exit application
application.exit();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetActiveClientCount-Boolean
Table Row (tr)
idname
Table Cell (td)

getActiveClientCount

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getActiveClientCount
Span
(currentSolutionOnly)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the active user count on the server (can be limited to current solution).
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} currentSolutionOnly - Boolean (true) to get the active user count on server only to the current solution
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - Active user count on the server
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var count = application.getActiveClientCount(true);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetActiveWindow
Table Row (tr)
idname
Table Cell (td)

getActiveWindow

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSWindow
Span
stylefont-weight: bold;
getActiveWindow
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
This gets the 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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSWindow - the current active/focussed window.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// get the currently active/focused window or dialog
var activeWindow = application.getActiveWindow();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetApplicationType
Table Row (tr)
idname
Table Cell (td)

getApplicationType

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getApplicationType
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the application type.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - Constant application type
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var type = application.getApplicationType();
//see application type contstant
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetClientCountForInfo-String
Table Row (tr)
idname
Table Cell (td)

getClientCountForInfo

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getClientCountForInfo
Span
(info)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the count for all clients displaying the same additional information
in the Clients page of Servoy Server Administration Console.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} info - The additional client info string to search for.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - Number of clients
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var count = application.getClientCountForInfo('SaaS company name');
application.output('Including yourself, there are ' + count + ' client(s) running on behalf of the company.');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetClientProperty-Object
Table Row (tr)
idname
Table Cell (td)

getClientProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
getClientProperty
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets a UI property.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} name - Name of the client property
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object - the property value for the given name/key, null of nothing was found
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//Only use this function from the solution on open method!
//In smart client, use this to set javax.swing.UIDefaults properties.
application.putClientProperty('ToolTip.hideAccelerator', true)
//To change the comboboxes selection background color, do this:
application.putClientProperty('ComboBox.selectionBackground', new Packages.javax.swing.plaf.ColorUIResource(java.awt.Color.RED))

//In web client, use this to change the template directory.
//To change the default dir of templates/default to templates/green_skin, do this:
application.putClientProperty('templates.dir','green_skin');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetClipboardString
Table Row (tr)
idname
Table Cell (td)

getClipboardString

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getClipboardString
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets a string from the clipboard, null if not a string or empty.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - The string from the clipboard
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var fromClipboard = application.getClipboardString();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetCurrentLookAndFeelName
Table Row (tr)
idname
Table Cell (td)

getCurrentLookAndFeelName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getCurrentLookAndFeelName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the name of the current Look And Feel specified in Application Preferences.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - Current Look And Feel
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var laf = application.getCurrentLookAndFeelName();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetHostName
Table Row (tr)
idname
Table Cell (td)

getHostName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getHostName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the name of the localhost.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - Name of the localhost
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var hostName = application.getHostName();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetIPAddress
Table Row (tr)
idname
Table Cell (td)

getIPAddress

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getIPAddress
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the clients' IP address.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - IP address of the client
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var ip = application.getIPAddress();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetLicenseNames
Table Row (tr)
idname
Table Cell (td)

getLicenseNames

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getLicenseNames
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the names of the used client licenses (as strings in array).
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[] - Client licenses names
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var array = application.getLicenseNames();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetOSName
Table Row (tr)
idname
Table Cell (td)

getOSName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getOSName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the name of the operating system.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - Name of the operating system
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var osname = application.getOSName();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetPrinters
Table Row (tr)
idname
Table Cell (td)

getPrinters

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getPrinters
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get all the printer names in an array.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[] - All printer names
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var printersArray = application.getPrinters();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetScreenHeight
Table Row (tr)
idname
Table Cell (td)

getScreenHeight

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getScreenHeight
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the screen height in pixels.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - Screen height
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var height = application.getScreenHeight();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetScreenWidth
Table Row (tr)
idname
Table Cell (td)

getScreenWidth

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getScreenWidth
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the screen width in pixels.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - Screen width
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var width = application.getScreenWidth();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetServerTimeStamp
Table Row (tr)
idname
Table Cell (td)

getServerTimeStamp

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Date
Span
stylefont-weight: bold;
getServerTimeStamp
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a date object initialized on server with current date and time.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Date - Server time
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var servertime = application.getServerTimeStamp();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetServerURL
Table Row (tr)
idname
Table Cell (td)

getServerURL

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getServerURL
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the HTTP server url.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - HTTP server URL
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var url = application.getServerURL();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetSolutionName
Table Row (tr)
idname
Table Cell (td)

getSolutionName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getSolutionName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the name of the current solution.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - Current solution name
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var solutionName = application.getSolutionName();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetSolutionRelease
Table Row (tr)
idname
Table Cell (td)

getSolutionRelease

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getSolutionRelease
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the solution release number.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - Current solution release number
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var release = application.getSolutionRelease();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetTimeStamp
Table Row (tr)
idname
Table Cell (td)

getTimeStamp

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Date
Span
stylefont-weight: bold;
getTimeStamp
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Date - Current time at the client
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var clienttime = application.getTimeStamp();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetUUID
Table Row (tr)
idname
Table Cell (td)

getUUID

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
UUID
Span
stylefont-weight: bold;
getUUID
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
UUID - The new UUID object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var new_uuid_object = application.getUUID(); // generate new uuid object
var uuid_object1 = application.getUUID(new_uuid_object.toString()); // convert a string representing an uuid to an uuid object
var uuid_object2 = application.getUUID(new_uuid_object.toBytes());  // convert a byte array representing an uuid to an uuid object
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetUUID-byteArray
Table Row (tr)
idname
Table Cell (td)

getUUID

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
UUID
Span
stylefont-weight: bold;
getUUID
Span
(byteArray)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{byte[]} byteArray - Byte array representing an uuid
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
UUID - The new UUID object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var new_uuid_object = application.getUUID(); // generate new uuid object
var uuid_object1 = application.getUUID(new_uuid_object.toString()); // convert a string representing an uuid to an uuid object
var uuid_object2 = application.getUUID(new_uuid_object.toBytes());  // convert a byte array representing an uuid to an uuid object
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetUUID-String
Table Row (tr)
idname
Table Cell (td)

getUUID

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
UUID
Span
stylefont-weight: bold;
getUUID
Span
(uuidString)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} uuidString - String representing an uuid
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
UUID - The new UUID object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var new_uuid_object = application.getUUID(); // generate new uuid object
var uuid_object1 = application.getUUID(new_uuid_object.toString()); // convert a string representing an uuid to an uuid object
var uuid_object2 = application.getUUID(new_uuid_object.toBytes());  // convert a byte array representing an uuid to an uuid object
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetUserProperty-String
Table Row (tr)
idname
Table Cell (td)

getUserProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getUserProperty
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get a persistent user property.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Name of the property
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - Property value
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var value = application.getUserProperty('showOrders');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetUserPropertyNames
Table Row (tr)
idname
Table Cell (td)

getUserPropertyNames

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getUserPropertyNames
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get all persistent user property names.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[] - Array of all user property names
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// display all user properties
allPropertyNames = application.getUserPropertyNames();
for(var i = 0; i < allPropertyNames.length; i++)
{
	application.output(allPropertyNames[i] + " = " + application.getUserProperty(allPropertyNames[i]));
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetValueListArray-String
Table Row (tr)
idname
Table Cell (td)

getValueListArray

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Array
Span
stylefont-weight: bold;
getValueListArray
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - The name of the valuelist
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Array - Named array for the valuelist
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var packet_types = application.getValueListArray('packet_types');
if (a_realValue == packet_types['displayValue'])
{
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetValueListDisplayValue-String_Object
Table Row (tr)
idname
Table Cell (td)

getValueListDisplayValue

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
getValueListDisplayValue
Span
(name, realValue)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Name of the valuelist
{Object} realValue - Real value of the valuelist
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object - Display value of the real value from the valuelist
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var displayable_status = application.getValueListDisplayValue('case_status',status);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetValueListItems-String
Table Row (tr)
idname
Table Cell (td)

getValueListItems

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSDataSet
Span
stylefont-weight: bold;
getValueListItems
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Name of the valuelist
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSDataSet - DataSet with valuelist's display values and real values
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//Note:see databaseManager.JSDataSet for full details of dataset
var dataset = application.getValueListItems('my_en_types');
//example to calc a strange total
global_total = 0;
for( var i = 1 ; i <= dataset.getMaxRowIndex() ; i++ )
{
	global_total = global_total + dataset.getValue(i,1);
}
//example to assign to dataprovider
//employee_salary = dataset.getValue(1,1)
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetValueListNames
Table Row (tr)
idname
Table Cell (td)

getValueListNames

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getValueListNames
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get all the valuelist names as array.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[] - Array with all valuelist names
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var array = application.getValueListNames();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetVersion
Table Row (tr)
idname
Table Cell (td)

getVersion

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getVersion
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the application version.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - Application version
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
application.getVersion();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetWindow
Table Row (tr)
idname
Table Cell (td)

getWindow

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSWindow
Span
stylefont-weight: bold;
getWindow
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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 when users (so not the developer through a createWindow() call) create there own tabs after

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 aways 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.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSWindow - the main application JSWindow.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// close and dispose window resources
var mainAppWindow = application.getWindow();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetWindow-String
Table Row (tr)
idname
Table Cell (td)

getWindow

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSWindow
Span
stylefont-weight: bold;
getWindow
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get a window by window name. When not supplying a name, the main application window is grabbed.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the name of the window. If not specified, the main application JSWindow will be returned.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSWindow - the JSWindow with the specified name, or null if no such window exists.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// close and dispose window resources
var win = application.getWindow("someWindowName");
if (win != null) {
	win.destroy();
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idisInDeveloper
Table Row (tr)
idname
Table Cell (td)

isInDeveloper

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
isInDeveloper
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns true if the solution is running in the developer.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - Boolean (true) if the solution is running in the developer, (false) otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var flag = application.isInDeveloper();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idisLastPrintPreviewPrinted
Table Row (tr)
idname
Table Cell (td)

isLastPrintPreviewPrinted

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
isLastPrintPreviewPrinted
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Check if the last printpreview did print.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - Boolean (true) is the last print preview did print, (false) otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//attached this method to onShow on the form being shown after printpreview
//set a global called scopes.globals.showPrintPreview to 1 in the onPrintPreview method
if (scopes.globals.showPrintPreview == 1)
{
	scopes.globals.showPrintPreview = 0;//clear for next time
	if (application.isLastPrintPreviewPrinted())
	{
		plugins.dialogs.showInfoDialog('Alert',  'There is printed in printpreview',  'OK')
	}
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idoutput-Object
Table Row (tr)
idname
Table Cell (td)

output

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
output
Span
(msg)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Output something on the out stream. (if running in debugger view output console tab)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} msg - Object to send to output stream
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// log level is used to determine how/if to log in servoy_log.txt; for smart client java out and err streams are used
application.output('my very important trace msg');// default log level: info
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idoutput-Object_Number
Table Row (tr)
idname
Table Cell (td)

output

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
output
Span
(msg, level)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Output something on the out stream. (if running in debugger view output console tab)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} msg - Object to send to output stream
{Number} level - the log level where it should log to.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
// log level is used to determine how/if to log in servoy_log.txt; for smart client java out and err streams are used
application.output('my very important msg',LOGGINGLEVEL.ERROR);// log level: error
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idoverrideStyle-String_String
Table Row (tr)
idname
Table Cell (td)

overrideStyle

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
overrideStyle
Span
(originalStyleName, newStyleName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Overrides one style (defined in in a form) with another.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} originalStyleName - Name of the style to override
{String} newStyleName - Name of the new style
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//This function will only have effect on  forms not yet created, so solution onLoad is the best place to override'
//For example overriding the use of default/designed style anywhere in the solution from 'mystyle' to 'mystyle_mac'
application.overrideStyle('mystyle','mystyle_mace')//in this case both styles should have about the same classes
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idplaySound-String
Table Row (tr)
idname
Table Cell (td)

playSound

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
playSound
Span
(url)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Play a sound (AU file, an AIFF file, a WAV file, and a MIDI file).
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} url - URL of the sound file
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.playSound('media:///click.wav');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idputClientProperty-Object_Object
Table Row (tr)
idname
Table Cell (td)

putClientProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
putClientProperty
Span
(name, value)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets a UI property.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} name - Name of the client property
{Object} value - New value of the client property
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - Boolean (true) if the client property was set with the new value
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//Only use this function from the solution on open method!
//In smart client, use this to set javax.swing.UIDefaults properties.
application.putClientProperty('ToolTip.hideAccelerator', true)
//To change the comboboxes selection background color, do this:
application.putClientProperty('ComboBox.selectionBackground', new Packages.javax.swing.plaf.ColorUIResource(java.awt.Color.RED))

//In web client, use this to change the template directory.
//To change the default dir of templates/default to templates/green_skin, do this:
application.putClientProperty('templates.dir','green_skin');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idredo
Table Row (tr)
idname
Table Cell (td)

redo

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
redo
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Redo last action (if possible).
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.redo();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveAllClientInfo
Table Row (tr)
idname
Table Cell (td)

removeAllClientInfo

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
removeAllClientInfo
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes all names given to the client via the admin page.
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.removeAllClientInfo();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveClientInfo-String
Table Row (tr)
idname
Table Cell (td)

removeClientInfo

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeClientInfo
Span
(info)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} info - A line of text to be removed from the client information
on behalf of the running Servoy client.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - boolean indicator if info was removed successfully
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var removed = application.removeClientInfo('SaaS company name');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetClipboardContent-Object
Table Row (tr)
idname
Table Cell (td)

setClipboardContent

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setClipboardContent
Span
(string)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets a string object in the clipboard.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} string - New content of the clipboard
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.setClipboardContent('test');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetNumpadEnterAsFocusNextEnabled-Boolean
Table Row (tr)
idname
Table Cell (td)

setNumpadEnterAsFocusNextEnabled

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setNumpadEnterAsFocusNextEnabled
Span
(enabled)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set if numpad enter should behave like focus next.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} enabled - Boolean (true) if numpad enter should behave like focus next
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.setNumpadEnterAsFocusNextEnabled(true);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetStatusText-String
Table Row (tr)
idname
Table Cell (td)

setStatusText

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setStatusText
Span
(text)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set the status area value.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text - New status text
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.setStatusText('Your status text');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetStatusText-String_String
Table Row (tr)
idname
Table Cell (td)

setStatusText

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setStatusText
Span
(text, tooltip)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set the status area value.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} text - New status text
{String} tooltip - Status tooltip text
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.setStatusText('Your status text','Your status tooltip text');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetToolbarVisible-String_Boolean
Table Row (tr)
idname
Table Cell (td)

setToolbarVisible

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setToolbarVisible
Span
(name, visible)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Make a toolbar visible or invisible.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Name of the toolbar
{Boolean} visible - Visibility of the toolbar
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//example: hide the text toolbar
application.setToolbarVisible('text',false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetUserProperty-String_String
Table Row (tr)
idname
Table Cell (td)

setUserProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setUserProperty
Span
(name, value)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets a user property for this client: <br>
For heedless clients((including Batch Processors and Authentication clients) the user property is stored in memory and will be lost upon client restart.
<br>
For Web client the user property will be stored in a persistent cookie
<br>
For Smart Client it will be stored in client local properties file
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Name of the user property
{String} value - New value of the user property
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.setUserProperty('showOrders','1');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetValueListItems-String_JSDataSet
Table Row (tr)
idname
Table Cell (td)

setValueListItems

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setValueListItems
Span
(name, dataset)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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 after form is created may have side effects

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Name of the valuelist
{JSDataSet} dataset - Dataset with display/real values
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//set display values (return values will be same as display values)
application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'));
//set display values and return values (which are stored in dataprovider)
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456));
//set display values and return values converted to numbers
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true);
//do query and fill valuelist (see databaseManager for full details of queries/dataset)
//var query = 'select display_value,optional_real_value from test_table';
//var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25);

//application.setValueListItems('my_en_types',dataset);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetValueListItems-String_JSDataSet_Boolean
Table Row (tr)
idname
Table Cell (td)

setValueListItems

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setValueListItems
Span
(name, dataset, autoconvert)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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 after form is created may have side effects

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Name of the valuelist
{JSDataSet} dataset - Dataset with display/real values
{Boolean} autoconvert - Boolean (true) if display values and return values should be converted to numbers
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//set display values (return values will be same as display values)
application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'));
//set display values and return values (which are stored in dataprovider)
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456));
//set display values and return values converted to numbers
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true);
//do query and fill valuelist (see databaseManager for full details of queries/dataset)
//var query = 'select display_value,optional_real_value from test_table';
//var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25);

//application.setValueListItems('my_en_types',dataset);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetValueListItems-String_ObjectArray
Table Row (tr)
idname
Table Cell (td)

setValueListItems

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setValueListItems
Span
(name, displayValues)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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 after form is created may have side effects

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Name of the valuelist
{Object[]} displayValues - Display values array
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//set display values (return values will be same as display values)
application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'));
//set display values and return values (which are stored in dataprovider)
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456));
//set display values and return values converted to numbers
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true);
//do query and fill valuelist (see databaseManager for full details of queries/dataset)
//var query = 'select display_value,optional_real_value from test_table';
//var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25);

//application.setValueListItems('my_en_types',dataset);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetValueListItems-String_ObjectArray_Boolean
Table Row (tr)
idname
Table Cell (td)

setValueListItems

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setValueListItems
Span
(name, displayValues, autoconvert)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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 after form is created may have side effects

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Name of the valuelist
{Object[]} displayValues - Display values array
{Boolean} autoconvert - Boolean (true) if display values and return values should be converted to numbers
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//set display values (return values will be same as display values)
application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'));
//set display values and return values (which are stored in dataprovider)
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456));
//set display values and return values converted to numbers
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true);
//do query and fill valuelist (see databaseManager for full details of queries/dataset)
//var query = 'select display_value,optional_real_value from test_table';
//var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25);

//application.setValueListItems('my_en_types',dataset);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetValueListItems-String_ObjectArray_ObjectArray
Table Row (tr)
idname
Table Cell (td)

setValueListItems

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setValueListItems
Span
(name, displayValues, realValues)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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 after form is created may have side effects

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Name of the valuelist
{Object[]} displayValues - Display values array
{Object[]} realValues - Real values array
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//set display values (return values will be same as display values)
application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'));
//set display values and return values (which are stored in dataprovider)
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456));
//set display values and return values converted to numbers
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true);
//do query and fill valuelist (see databaseManager for full details of queries/dataset)
//var query = 'select display_value,optional_real_value from test_table';
//var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25);

//application.setValueListItems('my_en_types',dataset);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetValueListItems-String_ObjectArray_ObjectArray_Boolean
Table Row (tr)
idname
Table Cell (td)

setValueListItems

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setValueListItems
Span
(name, displayValues, realValues, autoconvert)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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 after form is created may have side effects

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name
{Object[]} displayValues - Display values array
{Object[]} realValues - Real values array
{Boolean} autoconvert - Boolean (true) if display values and return values should be converted to numbers
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//set display values (return values will be same as display values)
application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'));
//set display values and return values (which are stored in dataprovider)
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array(10000,10010,10456));
//set display values and return values converted to numbers
//application.setValueListItems('my_en_types',new Array('Item 1', 'Item 2', 'Item 3'),new Array('10000','10010', '10456'), true);
//do query and fill valuelist (see databaseManager for full details of queries/dataset)
//var query = 'select display_value,optional_real_value from test_table';
//var dataset = databaseManager.getDataSetByQuery(databaseManager.getDataSourceServerName(controller.getDataSource()), query, null, 25);

//application.setValueListItems('my_en_types',dataset);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowCalendar
Table Row (tr)
idname
Table Cell (td)

showCalendar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Date
Span
stylefont-weight: bold;
showCalendar
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Date - Selected date or null if canceled
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var selectedDate = application.showCalendar();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowCalendar-String
Table Row (tr)
idname
Table Cell (td)

showCalendar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Date
Span
stylefont-weight: bold;
showCalendar
Span
(dateFormat)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dateFormat - Date format
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Date - Selected date or null if canceled
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var selectedDate = application.showCalendar();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowCalendar-Date
Table Row (tr)
idname
Table Cell (td)

showCalendar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Date
Span
stylefont-weight: bold;
showCalendar
Span
(selectedDate)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Date} selectedDate - Default selected date
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Date - Selected date or null if canceled
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var selectedDate = application.showCalendar();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowCalendar-Date_String
Table Row (tr)
idname
Table Cell (td)

showCalendar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Date
Span
stylefont-weight: bold;
showCalendar
Span
(selectedDate, dateFormat)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Date} selectedDate - Default selected date
{String} dateFormat - Date format
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Date - Selected date or null if canceled
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var selectedDate = application.showCalendar();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowColorChooser
Table Row (tr)
idname
Table Cell (td)

showColorChooser

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showColorChooser
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show the colorChooser. Returned value is in format #RRGGBB or null if canceled.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - selected color or null if canceled
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var selectedColor = application.showColorChooser();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowColorChooser-String
Table Row (tr)
idname
Table Cell (td)

showColorChooser

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showColorChooser
Span
(colorString)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show the colorChooser. Returned value is in format #RRGGBB or null if canceled.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} colorString - Default color
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - selected color or null if canceled
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var selectedColor = application.showColorChooser();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowFontChooser
Table Row (tr)
idname
Table Cell (td)

showFontChooser

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showFontChooser
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show the font chooser dialog. Returns the selected font. Can specify a default font.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - selected font
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var selectedFont = application.showFontChooser();
elements.myfield.font = selectedFont
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowFontChooser-String
Table Row (tr)
idname
Table Cell (td)

showFontChooser

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showFontChooser
Span
(defaultFont)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show the font chooser dialog. Returns the selected font. Can specify a default font.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} defaultFont - Default font
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - selected font
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var selectedFont = application.showFontChooser();
elements.myfield.font = selectedFont
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowForm-Object
Table Row (tr)
idname
Table Cell (td)

showForm

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showForm
Span
(form)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object} form - Form object or name
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.showForm('MyForm');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowI18NDialog
Table Row (tr)
idname
Table Cell (td)

showI18NDialog

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showI18NDialog
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - selected I18N key or null if cancel is pressed
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
application.showI18NDialog("servoy.button.close", "en");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowI18NDialog-String
Table Row (tr)
idname
Table Cell (td)

showI18NDialog

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showI18NDialog
Span
(keyToSelect)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} keyToSelect - Default selected key
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - selected I18N key or null if cancel is pressed
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
application.showI18NDialog("servoy.button.close", "en");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowI18NDialog-String_String
Table Row (tr)
idname
Table Cell (td)

showI18NDialog

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
showI18NDialog
Span
(keyToSelect, languageToSelect)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} keyToSelect - Default selected key
{String} languageToSelect - Default selected language
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - selected I18N key or null if cancel is pressed
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
application.showI18NDialog("servoy.button.close", "en");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowURL-String
Table Row (tr)
idname
Table Cell (td)

showURL

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
showURL
Span
(url)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows an URL in a browser.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} url - URL to show
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - Boolean (true) if URL was shown
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
application.showURL('http://www.example.com');

//webclient specific additional parameters...
//2nd parameter: target frame or named dialog/window, so its possible to control in which (internal) frame or dialog the url is loaded, '_self' is current window,'_blank' is new dialog, '_top' is main window
//3rd parameter: dialog options used when a dialog is specified, example: 'height=200,width=400,status=yes,toolbar=no,menubar=no,location=no'
//3rd or 4th parameter: a timeout in seconds when the url should be shown, immediately/0 is default'
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowURL-String_String
Table Row (tr)
idname
Table Cell (td)

showURL

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
showURL
Span
(url, webclientTarget)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows an URL in a browser.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} url - URL to show
{String} webclientTarget - Target frame or named dialog/window
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - Boolean (true) if URL was shown
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
application.showURL('http://www.example.com');

//webclient specific additional parameters...
//2nd parameter: target frame or named dialog/window, so its possible to control in which (internal) frame or dialog the url is loaded, '_self' is current window,'_blank' is new dialog, '_top' is main window
//3rd parameter: dialog options used when a dialog is specified, example: 'height=200,width=400,status=yes,toolbar=no,menubar=no,location=no'
//3rd or 4th parameter: a timeout in seconds when the url should be shown, immediately/0 is default'
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowURL-String_String_Number
Table Row (tr)
idname
Table Cell (td)

showURL

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
showURL
Span
(url, webclientTarget, timeout)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows an URL in a browser.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} url - URL to show
{String} webclientTarget - Target frame or named dialog/window
{Number} timeout - A timeout in seconds when the url should be shown
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - Boolean (true) if URL was shown
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
application.showURL('http://www.example.com');

//webclient specific additional parameters...
//2nd parameter: target frame or named dialog/window, so its possible to control in which (internal) frame or dialog the url is loaded, '_self' is current window,'_blank' is new dialog, '_top' is main window
//3rd parameter: dialog options used when a dialog is specified, example: 'height=200,width=400,status=yes,toolbar=no,menubar=no,location=no'
//3rd or 4th parameter: a timeout in seconds when the url should be shown, immediately/0 is default'
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowURL-String_String_String
Table Row (tr)
idname
Table Cell (td)

showURL

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
showURL
Span
(url, webclientTarget, webclientTargetOptions)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows an URL in a browser.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} url - URL to show
{String} webclientTarget - Target frame or named dialog/window
{String} webclientTargetOptions - Dialog options used when a dialog is specified / a timeout in seconds when the url should be shown
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - Boolean (true) if URL was shown
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
application.showURL('http://www.example.com');

//webclient specific additional parameters...
//2nd parameter: target frame or named dialog/window, so its possible to control in which (internal) frame or dialog the url is loaded, '_self' is current window,'_blank' is new dialog, '_top' is main window
//3rd parameter: dialog options used when a dialog is specified, example: 'height=200,width=400,status=yes,toolbar=no,menubar=no,location=no'
//3rd or 4th parameter: a timeout in seconds when the url should be shown, immediately/0 is default'
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowURL-String_String_String_Number
Table Row (tr)
idname
Table Cell (td)

showURL

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
showURL
Span
(url, webclientTarget, webclientTargetOptions, timeout)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows an URL in a browser.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} url - URL to show
{String} webclientTarget - Target frame or named dialog/window
{String} webclientTargetOptions - Dialog options used when a dialog is specified / a timeout in seconds when the url should be shown
{Number} timeout - A timeout in seconds when the url should be shown
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - Boolean (true) if URL was shown
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
application.showURL('http://www.example.com');

//webclient specific additional parameters...
//2nd parameter: target frame or named dialog/window, so its possible to control in which (internal) frame or dialog the url is loaded, '_self' is current window,'_blank' is new dialog, '_top' is main window
//3rd parameter: dialog options used when a dialog is specified, example: 'height=200,width=400,status=yes,toolbar=no,menubar=no,location=no'
//3rd or 4th parameter: a timeout in seconds when the url should be shown, immediately/0 is default'
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsleep-Number
Table Row (tr)
idname
Table Cell (td)

sleep

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
sleep
Span
(ms)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sleep for specified time (in milliseconds).
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} ms - Sleep time in milliseconds
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
//Sleep for 3 seconds
application.sleep(3000);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idundo
Table Row (tr)
idname
Table Cell (td)

undo

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
undo
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Undo last action (if possible).
Table Row (tr)
idret
Table Cell (td)

Returns

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

Sample

Div
classsIndent
Code Block
languagejavascript
application.undo();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idupdateUI
Table Row (tr)
idname
Table Cell (td)

updateUI

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
updateUI
Span
()
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idupdateUI-Number
Table Row (tr)
idname
Table Cell (td)

updateUI

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
updateUI
Span
(milliseconds)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} milliseconds - How long the update should take in milliseconds
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
classlastDetailRow
Table Cell (td)