Page History

Div

style	display:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Div

id	description

HTML Table

id
class	servoy sReturnTypes

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Return Types

Table Row (tr)

Table Cell (td)

Span

class	sWordList

DEFAULTS

Span

class	sWordList

JSBean

Span

class	sWordList

JSButton

Span

class	sWordList

JSCalendar

Span

class	sWordList

JSChecks

Span

class	sWordList

JSCombobox

Span

class	sWordList

JSComponent

Span

class	sWordList

JSField

Span

class	sWordList

JSFooter

Span

class	sWordList

JSForm

Span

class	sWordList

JSHeader

Span

class	sWordList

JSInsetList

Span

class	sWordList

JSLabel

Span

class	sWordList

JSList

Span

class	sWordList

JSMethod

Span

class	sWordList

JSPassword

Span

class	sWordList

JSRadios

Span

class	sWordList

JSText

Span

class	sWordList

JSTextArea

Span

class	sWordList

JSTitle

Span

class	sWordList

JSValueList

Span

class	sWordList

JSVariable

HTML Table

id
class	servoy sSummary

Colgroup Tag

...

Col

width	80px

...

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

...

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)

...

getForm(name)
Gets the specified form object and returns information about the form (see JSForm node).

...

Table Row (tr)

Table Cell (td)
JSForm[]

Table Cell (td)

...

getForms()
Get an array of all forms.

...

Table Row (tr)

Table Cell (td)
JSForm[]

Table Cell (td)

...

getForms(datasource)
Get an array of forms, that are all based on datasource/servername.

...

Table Row (tr)

Table Cell (td)
JSForm[]

Table Cell (td)

...

getForms(server, tablename)
Get an array of forms, that are all based on datasource/servername and tablename.

...

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)

...

getGlobalMethod(scopeName, name)
Gets an existing global method by the specified name.

...

Table Row (tr)

Table Cell (td)
JSMethod[]

Table Cell (td)

...

getGlobalMethods()
The list of all global methods.

...

Table Row (tr)

Table Cell (td)
JSMethod[]

Table Cell (td)

...

getGlobalMethods(scopeName)
The list of all global methods.

...

Table Row (tr)

Table Cell (td)
JSVariable

Table Cell (td)

...

getGlobalVariable(scopeName, name)
Gets an existing global variable by the specified name.

...

Table Row (tr)

Table Cell (td)
JSVariable[]

Table Cell (td)

...

getGlobalVariables()
Gets an array of all global variables.

...

Table Row (tr)

Table Cell (td)
JSVariable[]

Table Cell (td)

...

getGlobalVariables(scopeName)
Gets an array of all global variables.

...

Table Row (tr)

Table Cell (td)
JSList

Table Cell (td)

...

getListForm(formName)
Returns an existing list form.

...

Table Row (tr)

Table Cell (td)
JSList[]

Table Cell (td)

...

getListForms()
Get an array of all list-forms.

...

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)

...

getScopeNames()
Gets an array of all scope names used.

...

Table Row (tr)

Table Cell (td)
JSValueList

Table Cell (td)

...

getValueList(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)

...

getValueLists()
Gets an array of all valuelists for the currently active solution.

...

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)

...

Table Cell (td)
JSForm

...

newForm(name, dataSource

...

Table Cell (td)
JSForm

...

)
Creates a new JSForm Object.

...

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)

...

newGlobalMethod(scopeName, code)
Creates a new global method with the specified code in a scope.

...

Table Row (tr)

Table Cell (td)
JSVariable

Table Cell (td)

...

newGlobalVariable(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)

...

newListForm(formName, dataSource, textDataProviderID)
Creates a new list form, similar to an inset list but without the inset list's header and relation.

...

Table Row (tr)

Table Cell (td)
JSValueList

Table Cell (td)
newValueList(name, type) Creates a new valuelist with the specified name and number type.

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)

...

removeGlobalMethod(scopeName, name)
Removes the specified global method.

...

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)

...

removeGlobalVariable(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)

...

revertForm(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

id	function
class	servoy sDetail

Colgroup Tag

column

Col

padding

colspan

0px

2
width	100%

Col

Table Head (thead)

1

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan

2

Method Details

Table Body (tbody)

id	getForm-String

Table Row (tr)

id	name

Table Cell (td)
getForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSForm

Span

style	font-weight: bold;

getForm

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the specified form object and returns information about the form (see JSForm node).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name – - the specified name of the form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm – - a JSForm

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getForms

Table Row (tr)

id	name

Table Cell (td)
getForms

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSForm[]

Span

style	font-weight: bold;

getForms

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get an array of all forms.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm[] – - an array of JSForm type elements

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getForms-String

Table Row (tr)

id	name

Table Cell (td)
getForms

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSForm[]

Span

style	font-weight: bold;

getForms

Span
(datasource)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get an array of forms, that are all based on datasource/servername.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} datasource – - the datasource or servername

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm[] – - an array of JSForm type elements

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getForms-String_String

Table Row (tr)

id	name

Table Cell (td)
getForms

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSForm[]

Span

style	font-weight: bold;

getForms

Span
(server, tablename)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get an array of forms, that are all based on datasource/servername and tablename.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} server – - the datasource or servername
{String} tablename – - the tablename

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm[] – - an array of JSForm type elements

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalMethod-String_String

Table Row (tr)

id	name

Table Cell (td)
getGlobalMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSMethod

Span

style	font-weight: bold;

getGlobalMethod

Span
(scopeName, name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an existing global method by the specified name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} scopeName – - the scope in which the method is searched
{String} name – - the name of the specified global method

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod – - a JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalMethods

Table Row (tr)

id	name

Table Cell (td)
getGlobalMethods

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSMethod[]

Span

style	font-weight: bold;

getGlobalMethods

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The list of all global methods.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod[] – - an array of JSMethod type elements

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var methods = solutionModel.getGlobalMethods('globals'); 
for (var x in methods)

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalMethods-String

Table Row (tr)

id	name

Table Cell (td)
getGlobalMethods

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSMethod[]

Span

style	font-weight: bold;

getGlobalMethods

Span
(scopeName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The list of all global methods.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} scopeName – - limit to global methods of specified scope name

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod[] – - an array of JSMethod type elements

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var methods = solutionModel.getGlobalMethods('globals'); 
for (var x in methods) 
	application.output(methods[x].getName());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalVariable-String_String

Table Row (tr)

id	name

Table Cell (td)
getGlobalVariable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSVariable

Span

style	font-weight: bold;

getGlobalVariable

Span
(scopeName, name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an existing global variable by the specified name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} scopeName – - the scope in which the variable is searched
{String} name – - the specified name of the global variable

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSVariable – - a JSVariable

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalVariables

Table Row (tr)

id	name

Table Cell (td)
getGlobalVariables

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSVariable[]

Span

style	font-weight: bold;

getGlobalVariables

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of all global variables.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSVariable[] – - an array of JSVariable type elements

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getGlobalVariables-String

Table Row (tr)

id	name

Table Cell (td)
getGlobalVariables

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSVariable[]

Span

style	font-weight: bold;

getGlobalVariables

Span
(scopeName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of all global variables.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} scopeName – - limit to global vars of specified scope name

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSVariable[] – - an array of JSVariable type elements

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getListForm-

Table Row (tr)

id	name

Table Cell (td)
getListForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSList

Span

style	font-weight: bold;

getListForm

Span
(formName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an existing list form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

formName – - the form's name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSList – - the existing list form, or null if it does not exist.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getListForms

Table Row (tr)

id	name

Table Cell (td)
getListForms

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSList[]

Span

style	font-weight: bold;

getListForms

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get an array of all list-forms.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSList[] – - an array of IBaseSHList type elements

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getScopeNames

Table Row (tr)

id	name

Table Cell (td)
getScopeNames

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getScopeNames

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of all scope names used.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String[] – - an array of String scope names

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getValueList-String

Table Row (tr)

id	name

Table Cell (td)
getValueList

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSValueList

Span

style	font-weight: bold;

getValueList

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an existing valuelist by the specified name and returns a JSValueList Object that can be assigned to a field.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name – - the specified name of the valuelist

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSValueList – - a JSValueList object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getValueLists

Table Row (tr)

id	name

Table Cell (td)
getValueLists

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSValueList[]

Span

style	font-weight: bold;

getValueLists

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of all valuelists for the currently active solution.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSValueList[] – - an array of JSValueList objects

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newForm-String_String

Table Row (tr)

id	name

Table Cell (td)
newForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSForm

Span

style	font-weight: bold;

newForm

Span
(name, dataSource)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name – - the specified name of the form
{String} dataSource – - the specified name of the datasource for the specified table

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm – - a new JSForm object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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)

class	lastDetailRow

Table Cell (td)

newForm-String_String_String_String_Boolean_Number_Number

Table Body (tbody)

id	newFormnewGlobalMethod-String_String_String_Boolean_Number_Number

id

Table Row (tr)

id	name

Table Cell (td)

newForm

newGlobalMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSForm JSMethod

Span

style	font-weight: bold;

newFormnewGlobalMethod

Span
(name, dataSource, styleName, show_in_menu, width, heightscopeName, code)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

global method with the specified code in a scope.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name – the specified name of the formscopeName - the scope in which the method is created
{String} dataSource – code - the specified name of the datasource code for the specified table
{String} styleName – the specified style
{Boolean} show_in_menu – if true show the name of the new form in the menu; or false for not showing
{Number} width – the width of the form in pixels
{Number} height – the height of the form in pixels

Table Row (tr)

id	ret

global method

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm – a new JSForm JSMethod - a JSMethod object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var myFormmethod = solutionModel.newFormnewGlobalMethod('newFormglobals', 'db:/my_server/my_table', 'myStyleName', false, 800, 600)
//now you can add stuff to the form (under JSForm node)
//add a label
myForm.newLabel('Name', 20, 20, 120, 30)
//add a "normal" text entry field
myForm.newTextField('dataProviderNameHere', 140, 20, 140,20)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

function myglobalmethod(){foundset.newRecord()}')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newGlobalVariable-String_String_Number

Table Row (tr)

id	name

Table Cell (td)

newForm

newGlobalVariable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSForm JSVariable

Span

style	font-weight: bold;

newFormnewGlobalVariable

Span
(scopeName, name, serverName, tableName, styleName, show_in_menu, width, heighttype)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

NOTE: See the JSForm node for more information about form objects that can be added to the new formThe global variable number type is based on the value assigned from the SolutionModel-JSVariable node; for example: JSVariable.INTEGER.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name – the specified name of the form
{String} serverName – the specified name of the server for the specified table
{String} tableName – the specified name of the table
{String} styleName – the specified style
{Boolean} show_in_menu – if true show the name of the new form in the menu; or false for not showing
{Number} width – the width of the form in pixels
{Number} height – the height of the form in pixelsscopeName - 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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm – a new JSForm JSVariable - a JSVariable object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var myFormmyGlobalVariable = solutionModel.newFormnewGlobalVariable('newFormglobals', 'my_server', 'my_table', 'myStyleName', false, 800, 600)
//With only a datasource:
//var myForm = solutionModel.newForm('newForm', datasource, 'myStyleName', false, 800, 600)
//now you can add stuff to the form (under JSForm node)
//add a label
myForm.newLabel('Name', 20, 20, 120, 30)
//add a "normal" text entry field
myForm.newTextField('dataProviderNameHere', 140, 20, 140,20)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newGlobalMethod-String_String

Table Row (tr)

id	name

Table Cell (td)
newGlobalMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSMethod

Span

style	font-weight: bold;

newGlobalMethod

Span
(scopeName, code)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new global method with the specified code in a scope.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} scopeName – the scope in which the method is created
{String} code – the specified code for the global method

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod – a JSMethod object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var method = solutionModel.newGlobalMethod('globals', 'function myglobalmethod(){foundset.newRecord()}')
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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newListForm-String_String_String

Table Row (tr)

id	name

Table Cell (td)
newListForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSList

Span

style	font-weight: bold;

newListForm

Span
(formName, dataSource, textDataProviderID)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSList - the newly created list form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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 Row (tr)

class	lastDetailRow

Table Cell (td)

removeForm-

Table Body (tbody)

id	newGlobalVariablenewValueList-String_String_Number

id

Table Row (tr)

id	name

Table Cell (td)

newGlobalVariable

newValueList

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSVariable JSValueList

Span

style	font-weight: bold;

newGlobalVariablenewValueList

Span
(scopeName, name, type)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new global variable valuelist 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)

id	prs

Table Cell (td)

Parameters

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

Div

class	sIndent

class	sIndent

{String} name – - the specified name for the global variablevaluelist
{Number} type – - the specified number type for the global variablevaluelist; may be JSValueList.CUSTOM_VALUES, JSValueList.DATABASE_VALUES, JSValueList.EMPTY_VALUE_ALWAYS, JSValueList.EMPTY_VALUE_NEVER

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSVariable – JSValueList - a JSVariable JSValueList object

Table Row (tr)

id	sam

Table Cell (td)

Sample

var myGlobalVariable

Div

class	sIndent

Code Block

language	javascript

Code Block

language	javascript

var vl1 = solutionModel.newValueList("customText",JSValueList.CUSTOM_VALUES);
vl1.customValues = "customvalue1\ncustomvalue2";
var vl2 = solutionModel.newGlobalVariable('globals', 'newGlobalVariable', JSVariable.INTEGERnewValueList("customid",JSValueList.CUSTOM_VALUES);

myGlobalVariablevl2.defaultValuecustomValues = 12;
//myGlobalVariable.defaultValue"customvalue1|1\ncustomvalue2|2";
var form = "{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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newListForm-String_String_String

Table Row (tr)

id	name

Table Cell (td)
newListForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSList

Span

style	font-weight: bold;

newListForm

Span
(formName, dataSource, textDataProviderID)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSList – the newly created list form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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 Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeForm-String

Table Row (tr)

id	name

Table Cell (td)
removeForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeForm

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the form to remove

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true is form has been removed, false if form could not be removed

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeGlobalMethod-String_String

Table Row (tr)

id	name

Table Cell (td)

removeForm

removeGlobalMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeFormremoveGlobalMethod

Span
(scopeName, name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the specified form during the persistent connected client session.NOTE: Make sure you call history.remove first in your Servoy method (script)global method.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} scopeName - the scope in which the method is declared
{String} name – - the specified name of the form global method to removebe removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean – true is form has been removed, false if form could not be removed - true if the removal was successful, false otherwise

Table Row (tr)

id	sam

Sample
//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 Cell (td)

Div

class	sIndent

Code Block

language	javascript

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeGlobalMethodremoveGlobalVariable-String_String

Table Row (tr)

id	name

Table Cell (td)

removeGlobalMethod

removeGlobalVariable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeGlobalMethodremoveGlobalVariable

Span
(scopeName, name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the specified global methodvariable.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} scopeName – - the scope in which the method variable is declared
{String} name – - the name of the global method variable to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean – - true if the removal was successful, false otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var m1v1 = solutionModel.newGlobalMethodnewGlobalVariable('globals', 'function myglobalmethod1(){application.output("Global Method 1");}');
var m2'globals', 'globalVar1', JSVariable.INTEGER);
var v2 = solutionModel.newGlobalMethodnewGlobalVariable('globals', 'globalVar2'function myglobalmethod2(){application.output("Global Method 2");}', JSVariable.TEXT);

var success = solutionModel.removeGlobalMethodremoveGlobalVariable('globals', 'myglobalmethod1globalVar1');
if (success == false) application.output('!!! myglobalmethod1globalVar1 could not be removed !!!');

var list = solutionModel.getGlobalMethodsgetGlobalVariables('globals');
for (var i = 0; i < list.length; i++) { 
	application.output( i = 0; i < list.length; i++) {
	application.output(list[i].name + '[ ' + list[i].variableType + ']: ' + list[i].codevariableType);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeGlobalVariableremoveValueList-String_String

Table Row (tr)

id	name

Table Cell (td)

removeGlobalVariable

removeValueList

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeGlobalVariableremoveValueList

Span
(scopeName, name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes the specified global variablevaluelist.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

{String} scopeName – the scope in which the variable is declared

Div

class	sIndent

{String} name – the - name of the global variable valuelist to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean – - true if the removal was successful, false otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


var v1 = solutionModel.newGlobalVariable('globals', 'globalVar1', JSVariable.INTEGER)vlName = "customValueList";
var v2vl = solutionModel.newGlobalVariablenewValueList('globals', 'globalVar2', JSVariable.TEXT)vlName,JSValueList.CUSTOM_VALUES);
vl.customValues = "customvalue1\ncustomvalue2";

var successstatus = solutionModel.removeGlobalVariable('globals', 'globalVar1'removeValueList(vlName);
if (success == false)status) application.output("Removal has been done.");
else application.output('!!! globalVar1 could"ValueList not be removed !!!'.");

var listvls = solutionModel.getGlobalVariablesgetValueLists('globals');
if (vls != null) {
	for (var i = 0; i < listvls.length; i++) {
		application.output(listvls[i].name + '[ ' + list[i].variableType + ']: ' + list[i].variableType);
	}
	application.output("");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	revertForm-String

Table Row (tr)

id	name

Table Cell (td)
revertForm

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSForm

Span

style	font-weight: bold;

revertForm

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name – - the specified name of the form to revert

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm – - a JSForm object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript


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

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 9

New Version Current

Key

getForm

getForms

getForms

getForms

getGlobalMethod

getGlobalMethods

getGlobalMethods

getGlobalVariable

getGlobalVariables

getGlobalVariables

getListForm

getListForms

getScopeNames

getValueList

getValueLists

newForm

newForm

newGlobalMethod

newForm

newGlobalVariable

newGlobalMethod

newListForm

newGlobalVariable

newValueList

newListForm

removeForm

removeForm

removeGlobalMethod

removeGlobalMethod

removeGlobalVariable

removeGlobalVariable

removeValueList

revertForm