Table Head (thead) |
---|
Table Row (tr) |
---|
| Table Head (th) |
---|
| Method Details |
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Gets the specified form object and returns information about the form (see JSForm node). |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} name - the specified name of the form |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var myForm = solutionModel.getForm('existingFormName');
//get the style of the form (for all other properties see JSForm node)
var styleName = myForm.styleName; |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Get an array of all forms. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSForm[] - an array of JSForm type elements |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var forms = solutionModel.getForms()
for (var i in forms)
application.output(forms[i].name) |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Get an array of forms, that are all based on datasource/servername. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} datasource - the datasource or servername |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSForm[] - an array of JSForm type elements |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var forms = solutionModel.getForms(datasource)
for (var i in forms)
application.output(forms[i].name) |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Get an array of forms, that are all based on datasource/servername and tablename. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} server - the datasource or servername {String} tablename - the tablename |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSForm[] - an array of JSForm type elements |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var forms = solutionModel.getForms(datasource,tablename)
for (var i in forms)
application.output(forms[i].name) |
|
|
|
|
Table Body (tbody) |
---|
id | getGlobalMethod-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getGlobalMethod |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Gets an existing global method by the specified name. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} scopeName - the scope in which the method is searched {String} name - the name of the specified global method |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var method = solutionModel.getGlobalMethod('globals', 'nameOfGlobalMethod');
if (method != null) application.output(method.code); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getGlobalMethods |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| The list of all global methods. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSMethod[] - an array of JSMethod type elements |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var methods = solutionModel.getGlobalMethods('globals');
for (var x in methods)
application.output(methods[x].getName()); |
|
|
|
|
Table Body (tbody) |
---|
id | getGlobalMethods-String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getGlobalMethods |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| The list of all global methods. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} scopeName - limit to global methods of specified scope name |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSMethod[] - an array of JSMethod type elements |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var methods = solutionModel.getGlobalMethods('globals');
for (var x in methods)
application.output(methods[x].getName()); |
|
|
|
|
Table Body (tbody) |
---|
id | getGlobalVariable-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getGlobalVariable |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Gets an existing global variable by the specified name. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} scopeName - the scope in which the variable is searched {String} name - the specified name of the global variable |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var globalVariable = solutionModel.getGlobalVariable('globals', 'globalVariableName');
application.output(globalVariable.name + " has the default value of " + globalVariable.defaultValue); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getGlobalVariables |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Gets an array of all global variables. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSVariable[] - an array of JSVariable type elements |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var globalVariables = solutionModel.getGlobalVariables('globals');
for (var i in globalVariables)
application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue); |
|
|
|
|
Table Body (tbody) |
---|
id | getGlobalVariables-String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getGlobalVariables |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Gets an array of all global variables. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} scopeName - limit to global vars of specified scope name |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSVariable[] - an array of JSVariable type elements |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var globalVariables = solutionModel.getGlobalVariables('globals');
for (var i in globalVariables)
application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Returns an existing list form. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| formName - the form's name. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSList - the existing list form, or null if it does not exist. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var list = solutionModel.getListForm('created_by_sm_2'); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Get an array of all list-forms. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSList[] - an array of IBaseSHList type elements |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var forms = solutionModel.getListForms()
for (var i in forms)
application.output(forms[i].name) |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getScopeNames |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Gets an array of all scope names used. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| String[] - an array of String scope names |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var scopeNames = solutionModel.getScopeNames();
for (var name in scopeNames)
application.output(name); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getValueList |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Gets an existing valuelist by the specified name and returns a JSValueList Object that can be assigned to a field. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} name - the specified name of the valuelist |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var myValueList = solutionModel.getValueList('myValueListHere')
//now set the valueList property of your field
//myField.valuelist = myValueList |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
getValueLists |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Gets an array of all valuelists for the currently active solution. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var valueLists = solutionModel.getValueLists();
if (valueLists != null && valueLists.length != 0)
for (var i in valueLists)
application.output(valueLists[i].name); |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Creates a new JSForm Object. NOTE: See the JSForm node for more information about form objects that can be added to the new form. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} name - the specified name of the form {String} dataSource - the specified name of the datasource for the specified table |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSForm - a new JSForm object |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var myForm = solutionModel.newForm('newForm', 'db:/my_server/my_table')
//now you can add stuff to the form (under JSForm node)
//add a label
myForm.newLabel('Name', 1)
//add a "normal" text entry field
myForm.newTextField('dataProviderNameHere', 2) |
|
|
|
|
Table Body (tbody) |
---|
id | newGlobalMethod-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
newGlobalMethod |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Creates a new global method with the specified code in a scope. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} scopeName - the scope in which the method is created {String} code - the specified code for the global method |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var method = solutionModel.newGlobalMethod('globals', 'function myglobalmethod(){foundset.newRecord()}') |
|
|
|
|
Table Body (tbody) |
---|
id | newGlobalVariable-String_String_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
newGlobalVariable |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(scopeName, name, type) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Creates a new global variable with the specified name and number type. NOTE: The global variable number type is based on the value assigned from the SolutionModel-JSVariable node; for example: JSVariable.INTEGER. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} scopeName - the scope in which the variable is created {String} name - the specified name for the global variable {Number} type - the specified number type for the global variable |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var myGlobalVariable = solutionModel.newGlobalVariable('globals', 'newGlobalVariable', JSVariable.INTEGER);
myGlobalVariable.defaultValue = 12;
//myGlobalVariable.defaultValue = "{a:'First letter',b:'Second letter'}" // an js object, type must be media.
//myGlobalVariable.defaultValue = '"some text"'; // Use two pairs of quotes if you want to assign a String as default value. |
|
|
|
|
Table Body (tbody) |
---|
id | newListForm-String_String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Span |
---|
(formName, dataSource, textDataProviderID) |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Creates a new list form, similar to an inset list but without the inset list's header and relation. The result will be an independent form which behaves like a mobile list. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} formName - the new form's name. {String} dataSource - the list will be populated based on this datasource. {String} textDataProviderID - can be null; it's a convenience argument for setting the dataprovider that will be used to populate the main text area of the list's items. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| JSList - the newly created list form. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var f = solutionModel.newForm("created_by_sm_1","udm","contacts",null,false,100,380);
// create a button to go to it on the main form
b = f.newButton("Show created list form",0,9,10,10,
f.newMethod("function showListForm() { forms.created_by_sm_2.controller.show(); }"));
// create the actual list form
var list = f.createListForm('created_by_sm_2', databaseManager.getDataSource("udm","contacts"),"name_first");
list.onAction = solutionModel.getForm('created_by_sm_2').newMethod("function goBack() { history.back(); }"); |
|
|
|
|
Table Body (tbody) |
---|
id | newValueList-String_Number |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
newValueList |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Creates a new valuelist with the specified name and number type. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} name - the specified name for the valuelist {Number} type - the specified number type for the valuelist; may be JSValueList.CUSTOM_VALUES, JSValueList.DATABASE_VALUES, JSValueList.EMPTY_VALUE_ALWAYS, JSValueList.EMPTY_VALUE_NEVER |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var vl1 = solutionModel.newValueList("customText",JSValueList.CUSTOM_VALUES);
vl1.customValues = "customvalue1\ncustomvalue2";
var vl2 = solutionModel.newValueList("customid",JSValueList.CUSTOM_VALUES);
vl2.customValues = "customvalue1|1\ncustomvalue2|2";
var form = solutionModel.newForm("customValueListForm",controller.getDataSource(),null,true,300,300);
var combo1 = form.newComboBox("scopes.globals.text",10,10,120,20);
combo1.valuelist = vl1;
var combo2 = form.newComboBox("scopes.globals.id",10,60,120,20);
combo2.valuelist = vl2; |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Removes the specified form during the persistent connected client session. NOTE: Make sure you call history.remove first in your Servoy method (script). |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} name - the specified name of the form to remove |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Boolean - true is form has been removed, false if form could not be removed |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| //first remove it from the current history, to destroy any active form instance
var success = history.removeForm('myForm')
//removes the named form from this session, please make sure you called history.remove() first
if(success)
{
solutionModel.removeForm('myForm')
} |
|
|
|
|
Table Body (tbody) |
---|
id | removeGlobalMethod-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
removeGlobalMethod |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Removes the specified global method. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} scopeName - the scope in which the method is declared {String} name - the name of the global method to be removed |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Boolean - true if the removal was successful, false otherwise |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var m1 = solutionModel.newGlobalMethod('globals', 'function myglobalmethod1(){application.output("Global Method 1");}');
var m2 = solutionModel.newGlobalMethod('globals', 'function myglobalmethod2(){application.output("Global Method 2");}');
var success = solutionModel.removeGlobalMethod('globals', 'myglobalmethod1');
if (success == false) application.output('!!! myglobalmethod1 could not be removed !!!');
var list = solutionModel.getGlobalMethods('globals');
for (var i = 0; i < list.length; i++) {
application.output(list[i].code);
} |
|
|
|
|
Table Body (tbody) |
---|
id | removeGlobalVariable-String_String |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
removeGlobalVariable |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Removes the specified global variable. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} scopeName - the scope in which the variable is declared {String} name - the name of the global variable to be removed |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Boolean - true if the removal was successful, false otherwise |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var v1 = solutionModel.newGlobalVariable('globals', 'globalVar1', JSVariable.INTEGER);
var v2 = solutionModel.newGlobalVariable('globals', 'globalVar2', JSVariable.TEXT);
var success = solutionModel.removeGlobalVariable('globals', 'globalVar1');
if (success == false) application.output('!!! globalVar1 could not be removed !!!');
var list = solutionModel.getGlobalVariables('globals');
for (var i = 0; i < list.length; i++) {
application.output(list[i].name + '[ ' + list[i].variableType + ']: ' + list[i].variableType) |
|
|
|
| ;
}
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=revertForm-String|class=node}{tr:id=name}{td}h6.revertForm{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[JSForm]{span}{span:id=iets|style=float: left; font-weight: bold;}revertForm{span}{span:id=iets|style=float: left;}\(name){span}{td}{tr}{builder-show:permission=edit}{tr:id=des}{td}{sub-section:revertForm-String_des|trigger=button|text=}{sub-section}{sub-section:revertForm-String_des|trigger=none|class=sIndent}Replace with description{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:revertForm-String_snc|trigger=button|text=}{sub-section}{sub-section:revertForm-String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:revertForm-String_prs|trigger=button|text=}{sub-section}{sub-section:revertForm-String_prs|trigger=none|class=sIndent}\{[String]} name -- the specified name of the form to revert
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:revertForm-String_ret|trigger=button|text=}{sub-section}{sub-section:revertForm-String_ret|trigger=none|class=sIndent}[JSForm] -- a JSForm object{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:revertForm-String_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:revertForm-String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:revertForm-String_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:revertForm-String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:revertForm-String_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:revertForm-String_sam|trigger=none}{code:language=javascript}
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
removeValueList |
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Removes the specified valuelist. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} name - name of the valuelist to be removed |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Returns Div |
---|
| Boolean - true if the removal was successful, false otherwise |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| var vlName = "customValueList";
var vl = solutionModel.newValueList(vlName,JSValueList.CUSTOM_VALUES);
vl.customValues = "customvalue1\ncustomvalue2";
var status = solutionModel.removeValueList(vlName);
if (status) application.output("Removal has been done.");
else application.output("ValueList not removed.");
var vls = solutionModel.getValueLists();
if (vls != null) {
for (var i = 0; i < vls.length; i++) {
application.output(vls[i]);
}
application.output("");
} |
|
|
|
|
Table Body (tbody) |
---|
| Table Row (tr) |
---|
| Table Cell (td) |
---|
Div |
---|
| Reverts the specified form to the original (blueprint) version of the form; will result in an exception error if the form is not an original form. NOTE: Make sure you call history.remove first in your Servoy method (script) or call form.controller.recreateUI() before the script ends. |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Parameters Div |
---|
| {String} name - the specified name of the form to revert |
|
|
Table Row (tr) |
---|
| Table Cell (td) |
---|
Sample Div |
---|
| Code Block |
---|
| // revert the form to the original solution form, removing any changes done to it through the solution model.
var revertedForm = solutionModel.revertForm('myForm')
// add a label on a random place.
revertedForm.newLabel("MyLabel",Math.random()*100,Math.random()*100,80,20);
// make sure that the ui is up to date.
forms.myForm.controller.recreateUI(); |
|
|
|
|
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |