| Table Row (tr) |
|---|
| | Table Head (th) |
|---|
| | Method Details |
|
| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
addClientInfo |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} info – A line of text to be added as additional client information
on behalf of the running Servoy client. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.addClientInfo('SaaS company name');
application.addClientInfo('For any issues call +31-SA-AS');
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=beep}{tr:id=name}{td}h6.beep{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}beep{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Produces a "beep" sound; commonly used to indicate an error or warning dialog.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Produces a "beep" sound; commonly used to indicate an error or warning dialog. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.beep();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=closeAllWindows}{tr:id=name}{td}h6.closeAllWindows{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}closeAllWindows{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Close all visible windows (except main application window). Returns true if operation was successful.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- Boolean true if all windows were closed and false otherwise.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
closeAllWindows |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Close all visible windows (except main application window). Returns true if operation was successful. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Boolean – Boolean true if all windows were closed and false otherwise. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
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);
}
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=closeSolution}{tr:id=name}{td}h6.closeSolution{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}closeSolution{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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).{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
closeSolution |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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 ) |
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=closeSolution-String}{tr:id=name}{td}h6.closeSolution{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}closeSolution{span}{span}\(solutionToLoad){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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).{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} solutionToLoad -- Name of the solution to load
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
closeSolution |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} solutionToLoad – Name of the solution to load |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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 )
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | closeSolution-String_String |
|---|
|
}{:=}{td}h6.closeSolution{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
closeSolution |
|
|
}{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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 | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|
|
|
| application.closeSolution() |
|
|
|
{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} solutionToLoad -- Name of the solution to load
\{[String]} methodName -- Name of the global method to call
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} solutionToLoad – Name of the solution to load
{String} methodName – Name of the global method to call |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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 )
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | closeSolution-String_String_Object |
|---|
|
}{:=}{td}h6.closeSolution{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
closeSolution |
|
|
}{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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 | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|
|
|
| application.closeSolution() |
|
|
|
{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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 )
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | createNewFormInstance-String_String |
|---|
|
}{:=}{td}h6.createNewFormInstance{td}{tr}{tr:id=sig}{td}{span:style= }[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Create a new form instance.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} designFormName -- Name of the design form
\{[String]} newInstanceScriptName -- Name of the new form instance
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- Boolean (true) if the instance was created succesfully, (false) otherwise{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Create a new form instance. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} designFormName – Name of the design form
{String} newInstanceScriptName – Name of the new form instance |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Boolean – Boolean (true) if the instance was created succesfully, (false) otherwise |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
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)
}
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | createWindow-String_Number |
|---|
|
}{:=}{td}h6.createWindow{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
createWindow |
|
|
}[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSWindow] -- the newly created window.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | createWindow-String_Number_JSWindow |
|---|
|
}{:=}{td}h6.createWindow{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
createWindow |
|
|
}[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSWindow] -- the newly created window.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=executeProgram-String}{tr:id=name}{td}h6.executeProgram{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}executeProgram{span}{span}\(program){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Execute a program and returns output. Specify the cmd as you would do in a console.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} program -- (fullpath) of the program to execute
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The output generated by the program execution.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
executeProgram |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Execute a program and returns output. Specify the cmd as you would do in a console. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} program – (fullpath) of the program to execute |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – The output generated by the program execution. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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"]);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | executeProgram-String_StringArray |
|---|
|
}{:=}{td}h6.executeProgram{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
executeProgram |
|
|
}[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Execute a program and returns output. Specify the cmd as you would do in a console.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} program -- (fullpath) of the program to execute
\{[String]\[]} params -- an array of strings as program arguments
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The output generated by the program execution.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Execute a program and returns output. Specify the cmd as you would do in a console. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} program – (fullpath) of the program to execute
{String[]} params – an array of strings as program arguments |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – The output generated by the program execution. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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"]);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | executeProgram-String_StringArray_StringArray |
|---|
|
}{:=}{td}h6.executeProgram{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
executeProgram |
|
|
}[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Execute a program and returns output. Specify the cmd as you would do in a console.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The output generated by the program execution.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Execute a program and returns output. Specify the cmd as you would do in a console. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – The output generated by the program execution. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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"]);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | executeProgram-String_StringArray_StringArray_String |
|---|
|
}{:=}{td}h6.executeProgram{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
executeProgram |
|
|
}[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Execute a program and returns output. Specify the cmd as you would do in a console.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The output generated by the program execution.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Execute a program and returns output. Specify the cmd as you would do in a console. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – The output generated by the program execution. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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"]);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=executeProgramInBackground-String}{tr:id=name}{td}h6.executeProgramInBackground{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}executeProgramInBackground{span}{span}\(program){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Execute a program in the background. Specify the cmd as you would do in a console.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} program -- (fullpath) of the program to execute
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| id | executeProgramInBackground-String |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
executeProgramInBackground |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Span |
|---|
| | executeProgramInBackground |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Execute a program in the background. Specify the cmd as you would do in a console. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} program – (fullpath) of the program to execute |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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"]);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | executeProgramInBackground-String_StringArray |
|---|
|
}{:=}{td}h6.executeProgramInBackground{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
executeProgramInBackground |
|
|
}{span}{span:style= } | | executeProgramInBackground |
|
|
|
{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Execute a program in the background. Specify the cmd as you would do in a console.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} program -- (fullpath) of the program to execute
\{[String]\[]} params -- an array of strings as program arguments
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Execute a program in the background. Specify the cmd as you would do in a console. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} program – (fullpath) of the program to execute
{String[]} params – an array of strings as program arguments |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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"]);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | executeProgramInBackground-String_StringArray_StringArray |
|---|
|
}{:=}{td}h6.executeProgramInBackground{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
executeProgramInBackground |
|
|
}{span}{span:style= } | | executeProgramInBackground |
|
|
|
{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Execute a program in the background. Specify the cmd as you would do in a console.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Execute a program in the background. Specify the cmd as you would do in a console. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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"]);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | executeProgramInBackground-String_StringArray_StringArray_String |
|---|
|
}{:=}{td}h6.executeProgramInBackground{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
executeProgramInBackground |
|
|
}{span}{span:style= } | | executeProgramInBackground |
|
|
|
{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Execute a program in the background. Specify the cmd as you would do in a console.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Execute a program in the background. Specify the cmd as you would do in a console. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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"]);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=exit}{tr:id=name}{td}h6.exit{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}exit{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Stop and exit application.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Stop and exit application. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// exit application
application.exit();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getActiveClientCount-Boolean}{tr:id=name}{td}h6.getActiveClientCount{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getActiveClientCount{span}{span}\(currentSolutionOnly){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the active user count on the server (can be limited to current solution).{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} currentSolutionOnly -- Boolean (true) to get the active user count on server only to the current solution
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- Active user count on the server{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| id | getActiveClientCount-Boolean |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getActiveClientCount |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Span |
|---|
| (currentSolutionOnly) |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get the active user count on the server (can be limited to current solution). |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {Boolean} currentSolutionOnly – Boolean (true) to get the active user count on server only to the current solution |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Number – Active user count on the server |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var count = application.getActiveClientCount(true);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getActiveWindow}{tr:id=name}{td}h6.getActiveWindow{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSWindow]{span}{span:style=font-weight: bold;}getActiveWindow{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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 | Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getActiveWindow |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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() |
|
|
|
window it resides.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSWindow] -- the current active/focussed window.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | JSWindow – the current active/focussed window. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// get the currently active/focused window or dialog
var activeWindow = application.getActiveWindow();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getApplicationType}{tr:id=name}{td}h6.getApplicationType{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getApplicationType{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the application type.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- Constant application type{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getApplicationType |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get the application type. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Number – Constant application type |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var type = application.getApplicationType();
//see application type contstant
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getClientCountForInfo-String}{tr:id=name}{td}h6.getClientCountForInfo{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getClientCountForInfo{span}{span}\(info){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets the count for all clients displaying the same additional information
in the Clients page of Servoy Server Administration Console.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} info -- The additional client info string to search for.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- Number of clients{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| id | getClientCountForInfo-String |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getClientCountForInfo |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Span |
|---|
| | getClientCountForInfo |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
Parameters
| Div |
|---|
| | {String} info – The additional client info string to search for. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var count = application.getClientCountForInfo('SaaS company name');
application.output('Including yourself, there are ' + count + ' client(s) running on behalf of the company.');
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getClientProperty-Object}{tr:id=name}{td}h6.getClientProperty{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Object]{span}{span:style=font-weight: bold;}getClientProperty{span}{span}\(name){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sets a UI property.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]} name -- Name of the client property
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Object] -- the property value for the given name/key, null of nothing was found{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| id | getClientProperty-Object |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getClientProperty |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {Object} name – Name of the client property |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Object – the property value for the given name/key, null of nothing was found |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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');
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getClipboardString}{tr:id=name}{td}h6.getClipboardString{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getClipboardString{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets a string from the clipboard, null if not a string or empty.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- The string from the clipboard{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getClipboardString |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Gets a string from the clipboard, null if not a string or empty. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – The string from the clipboard |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var fromClipboard = application.getClipboardString();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentLookAndFeelName}{tr:id=name}{td}h6.getCurrentLookAndFeelName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getCurrentLookAndFeelName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets the name of the current Look And Feel specified in Application Preferences.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- Current Look And Feel{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| id | getCurrentLookAndFeelName |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getCurrentLookAndFeelName |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Span |
|---|
| | getCurrentLookAndFeelName |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Gets the name of the current Look And Feel specified in Application Preferences. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – Current Look And Feel |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var laf = application.getCurrentLookAndFeelName();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getHostName}{tr:id=name}{td}h6.getHostName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getHostName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the name of the localhost.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- Name of the localhost{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getHostName |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get the name of the localhost. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – Name of the localhost |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var hostName = application.getHostName();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getIPAddress}{tr:id=name}{td}h6.getIPAddress{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getIPAddress{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the clients' IP address.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- IP address of the client{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getIPAddress |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get the clients' IP address. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – IP address of the client |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var ip = application.getIPAddress();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLicenseNames}{tr:id=name}{td}h6.getLicenseNames{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]\[]{span}{span:style=font-weight: bold;}getLicenseNames{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the names of the used client licenses (as strings in array).{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[] -- Client licenses names{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getLicenseNames |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get the names of the used client licenses (as strings in array). |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String[] – Client licenses names |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var array = application.getLicenseNames();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getOSName}{tr:id=name}{td}h6.getOSName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getOSName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the name of the operating system.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- Name of the operating system{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Returns the name of the operating system. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – Name of the operating system |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var osname = application.getOSName();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getPrinters}{tr:id=name}{td}h6.getPrinters{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]\[]{span}{span:style=font-weight: bold;}getPrinters{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get all the printer names in an array.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[] -- All printer names{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getPrinters |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get all the printer names in an array. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String[] – All printer names |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var printersArray = application.getPrinters();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getScreenHeight}{tr:id=name}{td}h6.getScreenHeight{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getScreenHeight{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the screen height in pixels.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- Screen height{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getScreenHeight |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get the screen height in pixels. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var height = application.getScreenHeight();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getScreenWidth}{tr:id=name}{td}h6.getScreenWidth{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getScreenWidth{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the screen width in pixels.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- Screen width{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getScreenWidth |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get the screen width in pixels. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var width = application.getScreenWidth();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getServerTimeStamp}{tr:id=name}{td}h6.getServerTimeStamp{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Date]{span}{span:style=font-weight: bold;}getServerTimeStamp{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns a date object initialized on server with current date and time.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Date] -- Server time{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getServerTimeStamp |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Returns a date object initialized on server with current date and time. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var servertime = application.getServerTimeStamp();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getServerURL}{tr:id=name}{td}h6.getServerURL{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getServerURL{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets the HTTP server url.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- HTTP server URL{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getServerURL |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Gets the HTTP server url. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var url = application.getServerURL();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSolutionName}{tr:id=name}{td}h6.getSolutionName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getSolutionName{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the name of the current solution.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- Current solution name{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getSolutionName |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Returns the name of the current solution. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – Current solution name |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var solutionName = application. |
|
|
|
|
getSolutionName();
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSolutionRelease}{tr:id=name}{td}h6.getSolutionRelease{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getSolutionRelease{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the solution release number.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- Current solution release number{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getSolutionRelease |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get the solution release number. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Number – Current solution release number |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var release = application.getSolutionRelease();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTimeStamp}{tr:id=name}{td}h6.getTimeStamp{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Date]{span}{span:style=font-weight: bold;}getTimeStamp{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Date] -- Current time at the client{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getTimeStamp |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Date – Current time at the client |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var clienttime = application.getTimeStamp();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getUUID}{tr:id=name}{td}h6.getUUID{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[UUID]{span}{span:style=font-weight: bold;}getUUID{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[UUID] -- The new UUID object{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | 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) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | UUID – The new UUID object |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
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
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getUUID-byteArray}{tr:id=name}{td}h6.getUUID{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[UUID]{span}{span:style=font-weight: bold;}getUUID{span}{span}\(byteArray){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{byte[]} byteArray -- Byte array representing an uuid
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[UUID] -- The new UUID object{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {byte[]} byteArray – Byte array representing an uuid |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | UUID – The new UUID object |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
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
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getUUID-String}{tr:id=name}{td}h6.getUUID{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[UUID]{span}{span:style=font-weight: bold;}getUUID{span}{span}\(uuidString){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} uuidString -- String representing an uuid
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[UUID] -- The new UUID object{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} uuidString – String representing an uuid |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | UUID – The new UUID object |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
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
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getUserProperty-String}{tr:id=name}{td}h6.getUserProperty{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getUserProperty{span}{span}\(name){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get a persistent user property.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- Name of the property
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- Property value{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getUserProperty |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get a persistent user property. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} name – Name of the property |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var value = application.getUserProperty('showOrders');
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getUserPropertyNames}{tr:id=name}{td}h6.getUserPropertyNames{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]\[]{span}{span:style=font-weight: bold;}getUserPropertyNames{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get all persistent user property names.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[] -- Array of all user property names{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getUserPropertyNames |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get all persistent user property names. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String[] – Array of all user property names |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// display all user properties
allPropertyNames = application.getUserPropertyNames();
for(var i = 0; i < allPropertyNames.length; i++)
{
application.output(allPropertyNames[i] + " = " + application.getUserProperty(allPropertyNames[i]));
}
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getValueListArray-String}{tr:id=name}{td}h6.getValueListArray{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Array]{span}{span:style=font-weight: bold;}getValueListArray{span}{span}\(name){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- The name of the valuelist
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Array] -- Named array for the valuelist{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| id | getValueListArray-String |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getValueListArray |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} name – The name of the valuelist |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Array – Named array for the valuelist |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var packet_types = application.getValueListArray('packet_types');
if (a_realValue == packet_types['displayValue'])
{
}
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | getValueListDisplayValue-String_Object |
|---|
|
}{:=}{td}h6.getValueListDisplayValue{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
getValueListDisplayValue |
|
|
}[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- Name of the valuelist
\{[Object]} realValue -- Real value of the valuelist
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Object] -- Display value of the real value from the valuelist{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} name – Name of the valuelist
{Object} realValue – Real value of the valuelist |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Object – Display value of the real value from the valuelist |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var displayable_status = application.getValueListDisplayValue('case_status',status);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getValueListItems-String}{tr:id=name}{td}h6.getValueListItems{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSDataSet]{span}{span:style=font-weight: bold;}getValueListItems{span}{span}\(name){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- Name of the valuelist
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSDataSet] -- DataSet with valuelist's display values and real values{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| id | getValueListItems-String |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getValueListItems |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} name – Name of the valuelist |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | JSDataSet – DataSet with valuelist's display values and real values |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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)
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getValueListNames}{tr:id=name}{td}h6.getValueListNames{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]\[]{span}{span:style=font-weight: bold;}getValueListNames{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get all the valuelist names as array.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[] -- Array with all valuelist names{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getValueListNames |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get all the valuelist names as array. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String[] – Array with all valuelist names |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var array = application.getValueListNames();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getVersion}{tr:id=name}{td}h6.getVersion{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getVersion{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the application version.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- Application version{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
getVersion |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Returns the application version. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – Application version |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.getVersion();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getWindow}{tr:id=name}{td}h6.getWindow{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSWindow]{span}{span:style=font-weight: bold;}getWindow{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSWindow] -- the main application JSWindow.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | JSWindow – the main application JSWindow. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// close and dispose window resources
var mainAppWindow = application.getWindow( |
|
|
|
|
);
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getWindow-String}{tr:id=name}{td}h6.getWindow{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSWindow]{span}{span:style=font-weight: bold;}getWindow{span}{span}\(name){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get a window by window name. When not supplying a name, the main application window is grabbed.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- the name of the window. If not specified, the main application JSWindow will be returned.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSWindow] -- the JSWindow with the specified name, or null if no such window exists.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Get a window by window name. When not supplying a name, the main application window is grabbed. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} name – the name of the window. If not specified, the main application JSWindow will be returned. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | JSWindow – the JSWindow with the specified name, or null if no such window exists. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// close and dispose window resources
var win = application.getWindow("someWindowName");
if (win != null) {
win.destroy();
}
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isInDeveloper}{tr:id=name}{td}h6.isInDeveloper{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}isInDeveloper{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns true if the solution is running in the developer.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- Boolean (true) if the solution is running in the developer, (false) otherwise{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
isInDeveloper |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Returns true if the solution is running in the developer. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Boolean – Boolean (true) if the solution is running in the developer, (false) otherwise |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var flag = application.isInDeveloper();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=isLastPrintPreviewPrinted}{tr:id=name}{td}h6.isLastPrintPreviewPrinted{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}isLastPrintPreviewPrinted{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Check if the last printpreview did print.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- Boolean (true) is the last print preview did print, (false) otherwise{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| id | isLastPrintPreviewPrinted |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
isLastPrintPreviewPrinted |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Span |
|---|
| | isLastPrintPreviewPrinted |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Check if the last printpreview did print. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Boolean – Boolean (true) is the last print preview did print, (false) otherwise |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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')
}
}
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=output-Object}{tr:id=name}{td}h6.output{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}output{span}{span}\(msg){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Output something on the out stream. (if running in debugger view output console tab){div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]} msg -- Object to send to output stream
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Output something on the out stream. (if running in debugger view output console tab) |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {Object} msg – Object to send to output stream |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=}{:=}{td}h6.output{td}{tr}{tr:id=sig}{td}{span:style= }{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Output something on the out stream. (if running in debugger view output console tab){div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]} msg -- Object to send to output stream
\{[Number]} level -- the log level where it should log to.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Output something on the out stream. (if running in debugger view output console tab) |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {Object} msg – Object to send to output stream
{Number} level – the log level where it should log to. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
// 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
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | overrideStyle-String_String |
|---|
|
}{:=}{td}h6.overrideStyle{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
overrideStyle |
|
|
}{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Overrides one style (defined in in a form) with another.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} originalStyleName -- Name of the style to override
\{[String]} newStyleName -- Name of the new style
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Overrides one style (defined in in a form) with another. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} originalStyleName – Name of the style to override
{String} newStyleName – Name of the new style |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=playSound-String}{tr:id=name}{td}h6.playSound{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}playSound{span}{span}\(url){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Play a sound (AU file, an AIFF file, a WAV file, and a MIDI file).{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} url -- URL of the sound file
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Play a sound (AU file, an AIFF file, a WAV file, and a MIDI file). |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} url – URL of the sound file |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.playSound('media:///click.wav');
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | putClientProperty-Object_Object |
|---|
|
}{:=}{td}h6.putClientProperty{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
putClientProperty |
|
|
}[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sets a UI property.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]} name -- Name of the client property
\{[Object]} value -- New value of the client property
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- Boolean (true) if the client property was set with the new value{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {Object} name – Name of the client property
{Object} value – New value of the client property |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Boolean – Boolean (true) if the client property was set with the new value |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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');
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=redo}{tr:id=name}{td}h6.redo{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}redo{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Redo last action (if possible).{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Redo last action (if possible). |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.redo();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeAllClientInfo}{tr:id=name}{td}h6.removeAllClientInfo{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}removeAllClientInfo{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Removes all names given to the client via the admin page.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
removeAllClientInfo |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Removes all names given to the client via the admin page. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.removeAllClientInfo();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=removeClientInfo-String}{tr:id=name}{td}h6.removeClientInfo{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}removeClientInfo{span}{span}\(info){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Removes a string of client information which is stored on the server and
previously was added using the | Table Body (tbody) |
|---|
| id | removeClientInfo-String |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
removeClientInfo |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| Removes a string of client information which is stored on the server and
previously was added using the application.addClientInfo('client |
|
|
|
{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} info -- A line of text to be removed from the client information
on behalf of the running Servoy client.
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- boolean indicator if info was removed successfully{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} info – A line of text to be removed from the client information
on behalf of the running Servoy client. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Boolean – boolean indicator if info was removed successfully |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var removed = application.removeClientInfo('SaaS company name');
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setClipboardContent-Object}{tr:id=name}{td}h6.setClipboardContent{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setClipboardContent{span}{span}\(string){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sets a string object in the clipboard.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]} string -- New content of the clipboard
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| id | setClipboardContent-Object |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
setClipboardContent |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Sets a string object in the clipboard. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {Object} string – New content of the clipboard |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.setClipboardContent('test');
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setNumpadEnterAsFocusNextEnabled-Boolean}{tr:id=name}{td}h6.setNumpadEnterAsFocusNextEnabled{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setNumpadEnterAsFocusNextEnabled{span}{span}\(enabled){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Set if numpad enter should behave like focus next.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} enabled -- Boolean (true) if numpad enter should behave like focus next
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| id | setNumpadEnterAsFocusNextEnabled-Boolean |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
setNumpadEnterAsFocusNextEnabled |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Span |
|---|
| | setNumpadEnterAsFocusNextEnabled |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Set if numpad enter should behave like focus next. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {Boolean} enabled – Boolean (true) if numpad enter should behave like focus next |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.setNumpadEnterAsFocusNextEnabled(true);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setStatusText-String}{tr:id=name}{td}h6.setStatusText{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setStatusText{span}{span}\(text){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Set the status area value.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text -- New status text
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
setStatusText |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Set the status area value. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} text – New status text |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.setStatusText('Your status text');
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | setStatusText-String_String |
|---|
|
}{:=}{td}h6.setStatusText{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
setStatusText |
|
|
}{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Set the status area value.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} text -- New status text
\{[String]} tooltip -- Status tooltip text
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Set the status area value. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} text – New status text
{String} tooltip – Status tooltip text |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.setStatusText('Your status text','Your status tooltip |
|
|
|
|
text');
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | setToolbarVisible-String_Boolean |
|---|
|
}{:=}{td}h6.setToolbarVisible{td}{tr}{tr:id=sig}{td}{span:style= }{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Make a toolbar visible or invisible.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- Name of the toolbar
\{[Boolean]} visible -- Visibility of the toolbar
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Make a toolbar visible or invisible. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} name – Name of the toolbar
{Boolean} visible – Visibility of the toolbar |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//example: hide the text toolbar
application.setToolbarVisible('text',false);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | setUserProperty-String_String |
|---|
|
}{:=}{td}h6.setUserProperty{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
setUserProperty |
|
|
}{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Set a persistent user property.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- Name of the user property
\{[String]} value -- New value of the user property
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Set a persistent user property. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} name – Name of the user property
{String} value – New value of the user property |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.setUserProperty('showOrders','1');
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | setValueListItems-String_JSDataSet |
|---|
|
}{:=}{td}h6.setValueListItems{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
setValueListItems |
|
|
}{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Fill a custom type valuelist with values from | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| Fill a custom type valuelist with values from array(s) |
|
|
|
effects{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- Name of the valuelist
\{[JSDataSet]} dataset -- Dataset with display/real values
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} name – Name of the valuelist
{JSDataSet} dataset – Dataset with display/real values |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | setValueListItems-String_JSDataSet_Boolean |
|---|
|
}{:=}{td}h6.setValueListItems{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
setValueListItems |
|
|
}{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Fill a custom type valuelist with values from | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| Fill a custom type valuelist with values from array(s) |
|
|
|
effects{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | setValueListItems-String_ObjectArray |
|---|
|
}{:=}{td}h6.setValueListItems{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
setValueListItems |
|
|
}{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Fill a custom type valuelist with values from | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| Fill a custom type valuelist with values from array(s) |
|
|
|
effects{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- Name of the valuelist
\{[Object]\[]} displayValues -- Display values array
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} name – Name of the valuelist
{Object[]} displayValues – Display values array |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | setValueListItems-String_ObjectArray_Boolean |
|---|
|
}{:=}{td}h6.setValueListItems{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
setValueListItems |
|
|
}{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Fill a custom type valuelist with values from | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| Fill a custom type valuelist with values from array(s) |
|
|
|
effects{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | setValueListItems-String_ObjectArray_ObjectArray |
|---|
|
}{:=}{td}h6.setValueListItems{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
setValueListItems |
|
|
}{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Fill a custom type valuelist with values from | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| Fill a custom type valuelist with values from array(s) |
|
|
|
effects{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- Name of the valuelist
\{[Object]\[]} displayValues -- Display values array
\{[Object]\[]} realValues -- Real values array
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} name – Name of the valuelist
{Object[]} displayValues – Display values array
{Object[]} realValues – Real values array |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | setValueListItems-String_ObjectArray_ObjectArray_Boolean |
|---|
|
}{:=}{td}h6.setValueListItems{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
setValueListItems |
|
|
}{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Fill a custom type valuelist with values from | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| Fill a custom type valuelist with values from array(s) |
|
|
|
effects{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//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);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showCalendar}{tr:id=name}{td}h6.showCalendar{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Date]{span}{span:style=font-weight: bold;}showCalendar{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Date] -- Selected date or null if canceled{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
showCalendar |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Date – Selected date or null if canceled |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var selectedDate = application.showCalendar();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showCalendar-String}{tr:id=name}{td}h6.showCalendar{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Date]{span}{span:style=font-weight: bold;}showCalendar{span}{span}\(dateFormat){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dateFormat -- Date format
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Date] -- Selected date or null if canceled{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
showCalendar |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} dateFormat – Date format |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Date – Selected date or null if canceled |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var selectedDate = application.showCalendar();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showCalendar-Date}{tr:id=name}{td}h6.showCalendar{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Date]{span}{span:style=font-weight: bold;}showCalendar{span}{span}\(selectedDate){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Date]} selectedDate -- Default selected date
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Date] -- Selected date or null if canceled{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
showCalendar |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {Date} selectedDate – Default selected date |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Date – Selected date or null if canceled |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var selectedDate = application.showCalendar();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | showCalendar-Date_String |
|---|
|
}{:=}{td}h6.showCalendar{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
showCalendar |
|
|
}[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Date]} selectedDate -- Default selected date
\{[String]} dateFormat -- Date format
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Date] -- Selected date or null if canceled{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Show the calendar, returns selected date or null if canceled. Initial value and date format can be also specified. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {Date} selectedDate – Default selected date
{String} dateFormat – Date format |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Date – Selected date or null if canceled |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var selectedDate = application.showCalendar();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showColorChooser}{tr:id=name}{td}h6.showColorChooser{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showColorChooser{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Show the colorChooser. Returned value is in format #RRGGBB or null if canceled.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- selected color or null if canceled{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
showColorChooser |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Show the colorChooser. Returned value is in format #RRGGBB or null if canceled. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – selected color or null if canceled |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var selectedColor = application.showColorChooser();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showColorChooser-String}{tr:id=name}{td}h6.showColorChooser{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showColorChooser{span}{span}\(colorString){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Show the colorChooser. Returned value is in format #RRGGBB or null if canceled.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} colorString -- Default color
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- selected color or null if canceled{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| id | showColorChooser-String |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
showColorChooser |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Show the colorChooser. Returned value is in format #RRGGBB or null if canceled. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} colorString – Default color |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – selected color or null if canceled |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var selectedColor = application.showColorChooser();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showFontChooser}{tr:id=name}{td}h6.showFontChooser{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showFontChooser{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Show the font chooser dialog. Returns the selected font. Can specify a default font.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- selected font{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
showFontChooser |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Show the font chooser dialog. Returns the selected font. Can specify a default font. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var selectedFont = application.showFontChooser();
elements.myfield.font = selectedFont
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showFontChooser-String}{tr:id=name}{td}h6.showFontChooser{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showFontChooser{span}{span}\(defaultFont){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Show the font chooser dialog. Returns the selected font. Can specify a default font.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} defaultFont -- Default font
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- selected font{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
showFontChooser |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Show the font chooser dialog. Returns the selected font. Can specify a default font. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} defaultFont – Default font |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
var selectedFont = application.showFontChooser();
elements.myfield.font = selectedFont
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showForm-Object}{tr:id=name}{td}h6.showForm{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showForm{span}{span}\(form){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]} form -- Form object or name
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {Object} form – Form object or name |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.showForm('MyForm');
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showI18NDialog}{tr:id=name}{td}h6.showI18NDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showI18NDialog{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- selected I18N key or null if cancel is pressed{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
showI18NDialog |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | 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) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – selected I18N key or null if cancel is pressed |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.showI18NDialog("servoy.button.close", "en");
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showI18NDialog-String}{tr:id=name}{td}h6.showI18NDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}showI18NDialog{span}{span}\(keyToSelect){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} keyToSelect -- Default selected key
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- selected I18N key or null if cancel is pressed{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
showI18NDialog |
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {String} keyToSelect – Default selected key |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – selected I18N key or null if cancel is pressed |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.showI18NDialog("servoy.button.close", "en");
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | showI18NDialog-String_String |
|---|
|
}{:=}{td}h6.showI18NDialog{td}{tr}{tr:id=sig}{td}{span:style= | | Table Cell (td) |
|---|
showI18NDialog |
|
|
}[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} keyToSelect -- Default selected key
\{[String]} languageToSelect -- Default selected language
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- selected I18N key or null if cancel is pressed{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | 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) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} keyToSelect – Default selected key
{String} languageToSelect – Default selected language |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | String – selected I18N key or null if cancel is pressed |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.showI18NDialog("servoy.button.close", "en");
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showURL-String}{tr:id=name}{td}h6.showURL{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}showURL{span}{span}\(url){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Shows an URL in a browser.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} url -- URL to show
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- Boolean (true) if URL was shown{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Shows an URL in a browser. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Boolean – Boolean (true) if URL was shown |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
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'
//3th or 4th parameter: a timeout in seconds when the url should be shown, immediantly/0 is default'
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=}{:=}{td}h6.showURL{td}{tr}{tr:id=sig}{td}{span:style= }[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Shows an URL in a browser.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} url -- URL to show
\{[String]} webclientTarget -- Target frame or named dialog/window
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- Boolean (true) if URL was shown{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Shows an URL in a browser. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {String} url – URL to show
{String} webclientTarget – Target frame or named dialog/window |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Boolean – Boolean (true) if URL was shown |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
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'
//3th or 4th parameter: a timeout in seconds when the url should be shown, immediantly/0 is default'
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | showURL-String_String_Number |
|---|
|
}{:=}{td}h6.showURL{td}{tr}{tr:id=sig}{td}{span:style= }[]{span}{span:style= }{span}{span}\ timeout){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Shows an URL in a browser.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- Boolean (true) if URL was shown{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Shows an URL in a browser. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Boolean – Boolean (true) if URL was shown |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
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'
//3th or 4th parameter: a timeout in seconds when the url should be shown, immediantly/0 is default'
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | showURL-String_String_String |
|---|
|
}{:=}{td}h6.showURL{td}{tr}{tr:id=sig}{td}{span:style= }[]{span}{span:style= }{span}{span}\ {span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Shows an URL in a browser.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- Boolean (true) if URL was shown{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Shows an URL in a browser. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Boolean – Boolean (true) if URL was shown |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
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'
//3th or 4th parameter: a timeout in seconds when the url should be shown, immediantly/0 is default'
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=| Table Body (tbody) |
|---|
| id | showURL-String_String_String_Number |
|---|
|
}{:=}{td}h6.showURL{td}{tr}{tr:id=sig}{td}{span:style= }[]{span}{span:style= }{span}{span}\ timeout){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Shows an URL in a browser.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- Boolean (true) if URL was shown{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Shows an URL in a browser. |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| {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) |
|---|
| | Table Cell (td) |
|---|
Returns
| Div |
|---|
| | Boolean – Boolean (true) if URL was shown |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
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'
//3th or 4th parameter: a timeout in seconds when the url should be shown, immediantly/0 is default'
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=sleep-Number}{tr:id=name}{td}h6.sleep{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}sleep{span}{span}\(ms){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Sleep for specified time (in milliseconds).{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} ms -- Sleep time in milliseconds
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Sleep for specified time (in milliseconds). |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {Number} ms – Sleep time in milliseconds |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
//Sleep for 3 seconds
application.sleep(3000);
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=undo}{tr:id=name}{td}h6.undo{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}undo{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Undo last action (if possible).{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
| Div |
|---|
| | Undo last action (if possible). |
|
|
| Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Sample
| Div |
|---|
| | Code Block |
|---|
|
application.undo();
|
|
|
|
|
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=updateUI}{tr:id=name}{td}h6.updateUI{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}updateUI{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=updateUI-Number}{tr:id=name}{td}h6.updateUI{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}updateUI{span}{span}\(milliseconds){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} milliseconds -- How long the update should take in milliseconds
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}| Table Body (tbody) |
|---|
| | Table Row (tr) |
|---|
| | Table Cell (td) |
|---|
Parameters
| Div |
|---|
| | {Number} milliseconds – How long the update should take in milliseconds |
|
|
|
|