Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Rev: 1381949650879

...

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSForm
Table Cell (td)
#getFormgetForm(name)
Gets the specified form object and returns information about the form (see JSForm node).
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSForm[]
Table Cell (td)
#getFormsgetForms()
Get an array of all forms.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSForm[]
Table Cell (td)
#getFormsgetForms(datasource)
Get an array of forms, that are all based on datasource/servername.
Table Row (tr)
Table Cell (td)
JSForm[]
Table Cell (td)
#getFormsgetForms(server, tablename)
Get an array of forms, that are all based on datasource/servername and tablename.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#getGlobalMethodgetGlobalMethod(scopeName, name)
Gets an existing global method by the specified name.
tbody
Table Row (tr)
Table Cell (td)
JSMethod[]
Table Cell (td)
#getGlobalMethodsgetGlobalMethods()
The list of all global methods.
Table Row (tr)
Table Cell (td)
JSMethod[]
Table Cell (td)
#getGlobalMethodsgetGlobalMethods(scopeName)
The list of all global methods.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSVariable
Table Cell (td)
#getGlobalVariablegetGlobalVariable(scopeName, name)
Gets an existing global variable by the specified name.
tbody
Table Row (tr)
Table Cell (td)
JSVariable[]
Table Cell (td)
#getGlobalVariablesgetGlobalVariables()
Gets an array of all global variables.
Table Row (tr)
Table Cell (td)
JSVariable[]
Table Cell (td)
#getGlobalVariablesgetGlobalVariables(scopeName)
Gets an array of all global variables.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSList
Table Cell (td)
#getListFormgetListForm(formName)
Returns an existing list form.
Table Row (tr)
Table Cell (td)
JSList[]
Table Cell (td)
#getListFormsgetListForms()
Get an array of all list-forms.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
#getScopeNamesgetScopeNames()
Gets an array of all scope names used.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSValueList
Table Cell (td)
#getValueListgetValueList(name)
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)
JSValueList[]
Table Cell (td)
#getValueListsgetValueLists()
Gets an array of all valuelists for the currently active solution.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSForm
Table Cell (td)
#newFormnewForm(name, dataSource)
Creates a new JSForm Object.
Table Row (tr)
Table Cell (td)
JSFormJSMethod
Table Cell (td)
#newFormnewGlobalMethod(name, dataSource, styleName, show_in_menu, width, heightscopeName, code)
Creates a new JSForm Object.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSForm
Table Cell (td)
#newForm(name, serverName, tableName, styleName, show_in_menu, width, height)
Creates a new JSForm Object.
Table Body (tbody)
#newGlobalMethod(scopeName, code)
Creates a new global global method with the specified code in a scope.
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSVariable
Table Cell (td)
#newGlobalVariablenewGlobalVariable(scopeName, name, type)
Creates a new global variable with the specified name and number type.
Table Row (tr)
Table Cell (td)
JSList
Table Cell (td)
#newListFormnewListForm(formName, dataSource, textDataProviderID)
Creates a new list form, similar to an inset list but without the inset list's header and relation.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
BooleanJSValueList
Table Cell (td)
#removeFormnewValueList(name, type)
Removes the specified form during Creates a new valuelist with the specified name and number type.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeForm(name)
Removes the specified form during the persistent connected client session.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removeGlobalMethodremoveGlobalMethod(scopeName, name)
Removes the specified global method.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removeGlobalVariableremoveGlobalVariable(scopeName, name)
Removes the specified global variable.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeValueList(name)
Removes the specified valuelist.
Table Row (tr)
Table Cell (td)
JSForm
Table Cell (td)
#revertFormrevertForm(name)
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.

HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idgetForm-String
Table Row (tr)
idname
Table Cell (td)
getForm
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSForm
Span
stylefont-weight: bold;
getForm
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the specified form object and returns information about the form (see JSForm node).
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} name

...

- the specified name of the form
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSForm

...

- a JSForm
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var myForm = solutionModel.getForm('existingFormName');
//get the style of the form (for all other properties see JSForm node)
var styleName = myForm.styleName;

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetForms
Table Row (tr)
idname
Table Cell (td)
getForms
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSForm[]
Span
stylefont-weight: bold;
getForms
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get an array of all forms.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSForm[]

...

- an array of JSForm type elements
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var forms = solutionModel.getForms()
for (var i in forms)
	application.output(forms[i].name)

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetForms-String
Table Row (tr)
idname
Table Cell (td)
getForms
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSForm[]
Span
stylefont-weight: bold;
getForms
Span
(datasource)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get an array of forms, that are all based on datasource/servername.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} datasource

...

- the datasource or servername
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSForm[]

...

- an array of JSForm type elements
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var forms = solutionModel.getForms(datasource)
for (var i in forms)
	application.output(forms[i].name)

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetForms-String_String
Table Row (tr)
idname
Table Cell (td)
getForms
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSForm[]
Span
stylefont-weight: bold;
getForms
Span
(server, tablename)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get an array of forms, that are all based on datasource/servername and tablename.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} server

...

- the datasource or servername
{String} tablename

...

- the tablename
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSForm[]

...

- an array of JSForm type elements
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var forms = solutionModel.getForms(datasource,tablename)
for (var i in forms)
	application.output(forms[i].name)

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetGlobalMethod-String_String
Table Row (tr)
idname
Table Cell (td)
getGlobalMethod
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSMethod
Span
stylefont-weight: bold;
getGlobalMethod
Span
(scopeName, name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets an existing global method by the specified name.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} scopeName

...

- the scope in which the method is searched
{String} name

...

- the name of the specified global method
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod

...

- a JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var method = solutionModel.getGlobalMethod('globals', 'nameOfGlobalMethod');

...

if (method != null) application.output(method.code);

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetGlobalMethods
Table Row (tr)
idname
Table Cell (td)
getGlobalMethods
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSMethod[]
Span
stylefont-weight: bold;
getGlobalMethods
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The list of all global methods.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod[]

...

- an array of JSMethod type elements
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var methods = solutionModel.getGlobalMethods('globals');

...

for (var x in methods)

...

	application.output(methods[x].getName());

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetGlobalMethods-String
Table Row (tr)
idname
Table Cell (td)
getGlobalMethods
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSMethod[]
Span
stylefont-weight: bold;
getGlobalMethods
Span
(scopeName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The list of all global methods.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} scopeName

...

- limit to global methods of specified scope name
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSMethod[]

...

- an array of JSMethod type elements
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var methods = solutionModel.getGlobalMethods('globals');

...

for (var x in methods)

...

	application.output(methods[x].getName());

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetGlobalVariable-String_String
Table Row (tr)
idname
Table Cell (td)
getGlobalVariable
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSVariable
Span
stylefont-weight: bold;
getGlobalVariable
Span
(scopeName, name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets an existing global variable by the specified name.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} scopeName

...

- the scope in which the variable is searched
{String} name

...

- the specified name of the global variable
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSVariable

...

- a JSVariable
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var globalVariable = solutionModel.getGlobalVariable('globals', 'globalVariableName');
application.output(globalVariable.name + " has the default value of " + globalVariable.defaultValue);

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetGlobalVariables
Table Row (tr)
idname
Table Cell (td)
getGlobalVariables
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSVariable[]
Span
stylefont-weight: bold;
getGlobalVariables
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets an array of all global variables.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSVariable[]

...

- an array of JSVariable type elements
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var globalVariables = solutionModel.getGlobalVariables('globals');
for (var i in globalVariables)
	application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue);

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetGlobalVariables-String
Table Row (tr)
idname
Table Cell (td)
getGlobalVariables
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSVariable[]
Span
stylefont-weight: bold;
getGlobalVariables
Span
(scopeName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets an array of all global variables.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} scopeName

...

- limit to global vars of specified scope name
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSVariable[]

...

- an array of JSVariable type elements
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var globalVariables = solutionModel.getGlobalVariables('globals');
for (var i in globalVariables)
	application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue);

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetListForm-
Table Row (tr)
idname
Table Cell (td)
getListForm
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSList
Span
stylefont-weight: bold;
getListForm
Span
(formName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an existing list form.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
formName

...

- the form's name.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSList

...

- the existing list form, or null if it does not exist.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var list = solutionModel.getListForm('created_by_sm_2');

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetListForms
Table Row (tr)
idname
Table Cell (td)
getListForms
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSList[]
Span
stylefont-weight: bold;
getListForms
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get an array of all list-forms.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSList[]

...

- an array of IBaseSHList type elements
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var forms = solutionModel.getListForms()
for (var i in forms)
	application.output(forms[i].name)

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetScopeNames
Table Row (tr)
idname
Table Cell (td)
getScopeNames
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getScopeNames
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets an array of all scope names used.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String[]

...

- an array of String scope names
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var scopeNames = solutionModel.getScopeNames();
for (var name in scopeNames)
	application.output(name);

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetValueList-String
Table Row (tr)
idname
Table Cell (td)
getValueList
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSValueList
Span
stylefont-weight: bold;
getValueList
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets an existing valuelist by the specified name and returns a JSValueList Object that can be assigned to a field.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} name

...

- the specified name of the valuelist
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSValueList

...

- a JSValueList object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var myValueList = solutionModel.getValueList('myValueListHere')
//now set the valueList property of your field
//myField.valuelist = myValueList

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetValueLists
Table Row (tr)
idname
Table Cell (td)
getValueLists
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSValueList[]
Span
stylefont-weight: bold;
getValueLists
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets an array of all valuelists for the currently active solution.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSValueList[]

...

- an array of JSValueList objects
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var valueLists = solutionModel.getValueLists();
if (valueLists != null && valueLists.length != 0)
	for (var i in valueLists)
		application.output(valueLists[i].name);

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idnewForm-String_String
Table Row (tr)
idname
Table Cell (td)
newForm
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSForm
Span
stylefont-weight: bold;
newForm
Span
(name, dataSource)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} name

...

- the specified name of the form
{String} dataSource

...

- the specified name of the datasource for the specified table
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSForm

...

- a new JSForm object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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 Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
id

...

newGlobalMethod-String_String

...

Table Row (tr)
idname
Table Cell (td)

newForm

newGlobalMethod
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;

...

JSMethod
Span
stylefont-weight: bold;

...

newGlobalMethod
Span
(

...

scopeName, code)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new

...

global method with the specified code in a scope.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String}

...

scopeName - the scope in which the method is created
{String}

...

code - the specified

...

code for the

...

idret

...

global method
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent

...

JSMethod - a JSMethod object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var 

...

method = solutionModel.

...

newGlobalMethod('

...

globals', '

...

classlastDetailRow

...

function myglobalmethod(){foundset.newRecord()}')
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idnewGlobalVariable-String_String_Number
Table Row (tr)
idname
Table Cell (td)

newForm

newGlobalVariable
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;

...

JSVariable
Span
stylefont-weight: bold;

...

newGlobalVariable
Span
(scopeName, name,

...

type)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String}

...

scopeName - the scope in which the variable is created
{String}

...

name - the specified name

...

for the

...

global variable
{

...

Number}

...

type - the specified

...

idret

number type for the global variable
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent

...

JSVariable - a JSVariable object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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 Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
id

...

newListForm-String_String_String
Table Row (tr)
idname
Table Cell (td)

newGlobalMethod

newListForm
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;

...

JSList
Span
stylefont-weight: bold;

...

newListForm
Span
(

...

formName,

...

dataSource, textDataProviderID)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{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)
idret
Table Cell (td)
Returns
Div
classsIndent

...

JSList - the newly created list form.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

var 

...

f = solutionModel.

...

classlastDetailRow

...

idnewGlobalVariable-String_String_Number
Table Row (tr)
idname
Table Cell (td)
newGlobalVariable
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSVariable
Span
stylefont-weight: bold;
newGlobalVariable
Span
(scopeName, name, type)

...

iddes

...

classsIndent

Creates a new global variable with the specified name and number type.

...

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 Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idnewValueList-String_Number
Table Row (tr)
idname
Table Cell (td)
newValueList
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSValueList
Span
stylefont-weight: bold;
newValueList
Span
(name, type)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new valuelist with the specified name and number type.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{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)
idret
Table Cell (td)
Returns
Div
classsIndent

...

JSValueList - a

...

JSValueList object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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 Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
id

...

removeForm-String

...

Table Row (tr)
idname
Table Cell (td)

newListForm

removeForm
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;

...

Boolean
Span
stylefont-weight: bold;

...

removeForm
Span
(

...

name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

...

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)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String}

...

name - the specified name of the form to remove
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent

...

Boolean - true is form has been removed, false if form could not be removed
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block

...

languagejavascript

...


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(); }");

...

classlastDetailRow

...

idremoveForm-String
Table Row (tr)
idname
Table Cell (td)
removeForm
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeForm
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} name – the specified name of the form to remove
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean – true is form has been removed, false if form could not be removed

...

idsam

...

classsIndent

...

languagejavascript

...

languagejavascript
//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 Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idremoveGlobalMethod-String_String
Table Row (tr)
idname
Table Cell (td)
removeGlobalMethod
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeGlobalMethod
Span
(scopeName, name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes the specified global method.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} scopeName - the scope in which the method is declared
{String} name - the name of the global method to be removed
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean - true if the removal was successful, false otherwise
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
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 Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
id

...

removeGlobalVariable-String_String
Table Row (tr)
idname
Table Cell (td)

removeGlobalMethod

removeGlobalVariable
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;

...

removeGlobalVariable
Span
(scopeName, name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes the specified global

...

variable.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} scopeName

...

- the scope in which the

...

variable is declared
{String} name

...

- the name of the global

...

variable to be removed
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean

...

- true if the removal was successful, false otherwise
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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);
}

...

Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
id

...

removeValueList-

...

String
Table Row (tr)
idname
Table Cell (td)

removeGlobalVariable

removeValueList
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;

...

removeValueList
Span
(

...

name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes the specified

...

valuelist.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent

...

{String} name

...

- name of the

...

valuelist to be removed
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean

...

- true if the removal was successful, false otherwise
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

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 Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idrevertForm-String
Table Row (tr)
idname
Table Cell (td)
revertForm
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSForm
Span
stylefont-weight: bold;
revertForm
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} name

...

- the specified name of the form to revert
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
JSForm

...

- a JSForm object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

...

// 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();

...

Table Row (tr)
classlastDetailRow
Table Cell (td)