Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Unknown macro: {div}

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'

Unknown macro: {div}


Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Return Types

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

DEFAULTS

Unknown macro: {span}

JSBean

Unknown macro: {span}

JSButton

Unknown macro: {span}

JSCalendar

Unknown macro: {span}

JSChecks

Unknown macro: {span}

JSCombobox

Unknown macro: {span}

JSComponent

Unknown macro: {span}

JSField

Unknown macro: {span}

JSFooter

Unknown macro: {span}

JSForm

Unknown macro: {span}

JSHeader

Unknown macro: {span}

JSInsetList

Unknown macro: {span}

JSLabel

Unknown macro: {span}

JSList

Unknown macro: {span}

JSMethod

Unknown macro: {span}

JSPassword

Unknown macro: {span}

JSRadios

Unknown macro: {span}

JSText

Unknown macro: {span}

JSTextArea

Unknown macro: {span}

JSTitle

Unknown macro: {span}

JSValueList

Unknown macro: {span}

JSVariable


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm[]

Unknown macro: {td}

getForms()
Get an array of all forms.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm[]

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm[]

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMethod

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMethod[]

Unknown macro: {td}

getGlobalMethods()
The list of all global methods.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMethod[]

Unknown macro: {td}

getGlobalMethods(scopeName)
The list of all global methods.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSVariable

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSVariable[]

Unknown macro: {td}

getGlobalVariables()
Gets an array of all global variables.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSVariable[]

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSList

Unknown macro: {td}

getListForm(formName)
Returns an existing list form.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSList[]

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String[]

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSValueList

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSValueList[]

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm

Unknown macro: {td}

newForm(name, dataSource)
Creates a new JSForm Object.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm

Unknown macro: {td}

newForm(name, dataSource, styleName, show_in_menu, width, height)
Creates a new JSForm Object.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm

Unknown macro: {td}

newForm(name, serverName, tableName, styleName, show_in_menu, width, height)
Creates a new JSForm Object.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSMethod

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSVariable

Unknown macro: {td}

newGlobalVariable(scopeName, name, type)
Creates a new global variable with the specified name and number type.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSList

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

removeForm(name)
Removes the specified form during the persistent connected client session.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

removeGlobalVariable(scopeName, name)
Removes the specified global variable.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSForm

Unknown macro: {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.


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm

Unknown macro: {span}

getForm

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the form

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm – a JSForm

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var myForm = solutionModel.getForm('existingFormName');
//get the style of the form (for all other properties see JSForm node)
var styleName = myForm.styleName;
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getForms
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm[]

Unknown macro: {span}

getForms

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get an array of all forms.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm[] – an array of JSForm type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var forms = solutionModel.getForms()
for (var i in forms)
	application.output(forms[i].name)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getForms
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm[]

Unknown macro: {span}

getForms

Unknown macro: {span}

(datasource)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} datasource – the datasource or servername

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm[] – an array of JSForm type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var forms = solutionModel.getForms(datasource)
for (var i in forms)
	application.output(forms[i].name)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getForms
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm[]

Unknown macro: {span}

getForms

Unknown macro: {span}

(server, tablename)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm[] – an array of JSForm type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var forms = solutionModel.getForms(datasource,tablename)
for (var i in forms)
	application.output(forms[i].name)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalMethod
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMethod

Unknown macro: {span}

getGlobalMethod

Unknown macro: {span}

(scopeName, name)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Gets an existing global method by the specified name.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMethod – a JSMethod

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var method = solutionModel.getGlobalMethod('globals', 'nameOfGlobalMethod'); 
if (method != null) application.output(method.code);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalMethods
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMethod[]

Unknown macro: {span}

getGlobalMethods

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

The list of all global methods.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMethod[] – an array of JSMethod type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var methods = solutionModel.getGlobalMethods('globals'); 
for (var x in methods) 
	application.output(methods[x].getName());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalMethods
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMethod[]

Unknown macro: {span}

getGlobalMethods

Unknown macro: {span}

(scopeName)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

The list of all global methods.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMethod[] – an array of JSMethod type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var methods = solutionModel.getGlobalMethods('globals'); 
for (var x in methods) 
	application.output(methods[x].getName());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalVariable
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable

Unknown macro: {span}

getGlobalVariable

Unknown macro: {span}

(scopeName, name)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Gets an existing global variable by the specified name.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSVariable – a JSVariable

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var globalVariable = solutionModel.getGlobalVariable('globals', 'globalVariableName');
application.output(globalVariable.name + " has the default value of " + globalVariable.defaultValue);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalVariables
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable[]

Unknown macro: {span}

getGlobalVariables

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Gets an array of all global variables.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSVariable[] – an array of JSVariable type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var globalVariables = solutionModel.getGlobalVariables('globals');
for (var i in globalVariables)
	application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getGlobalVariables
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable[]

Unknown macro: {span}

getGlobalVariables

Unknown macro: {span}

(scopeName)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Gets an array of all global variables.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSVariable[] – an array of JSVariable type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var globalVariables = solutionModel.getGlobalVariables('globals');
for (var i in globalVariables)
	application.output(globalVariables[i].name + " has the default value of " + globalVariables[i].defaultValue);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getListForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSList

Unknown macro: {span}

getListForm

Unknown macro: {span}

(formName)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Returns an existing list form.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

formName – the form's name.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var list = solutionModel.getListForm('created_by_sm_2');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getListForms
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSList[]

Unknown macro: {span}

getListForms

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get an array of all list-forms.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSList[] – an array of IBaseSHList type elements

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var forms = solutionModel.getListForms()
for (var i in forms)
	application.output(forms[i].name)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getScopeNames
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String[]

Unknown macro: {span}

getScopeNames

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Gets an array of all scope names used.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String[] – an array of String scope names

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var scopeNames = solutionModel.getScopeNames();
for (var name in scopeNames)
	application.output(name);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getValueList
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSValueList

Unknown macro: {span}

getValueList

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the valuelist

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSValueList – a JSValueList object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var myValueList = solutionModel.getValueList('myValueListHere')
//now set the valueList property of your field
//myField.valuelist = myValueList
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getValueLists
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSValueList[]

Unknown macro: {span}

getValueLists

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSValueList[] – an array of JSValueList objects

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var valueLists = solutionModel.getValueLists();
if (valueLists != null && valueLists.length != 0)
	for (var i in valueLists)
		application.output(valueLists[i].name);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm

Unknown macro: {span}

newForm

Unknown macro: {span}

(name, dataSource)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {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.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm – a new JSForm object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm

Unknown macro: {span}

newForm

Unknown macro: {span}

(name, dataSource, styleName, show_in_menu, width, height)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {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.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – the specified name of the form
{String} dataSource – the specified name of the datasource 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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm – a new JSForm object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var myForm = solutionModel.newForm('newForm', '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)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm

Unknown macro: {span}

newForm

Unknown macro: {span}

(name, serverName, tableName, styleName, show_in_menu, width, height)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {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.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm – a new JSForm object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var myForm = solutionModel.newForm('newForm', '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)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newGlobalMethod
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMethod

Unknown macro: {span}

newGlobalMethod

Unknown macro: {span}

(scopeName, code)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSMethod – a JSMethod object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var method = solutionModel.newGlobalMethod('globals', 'function myglobalmethod(){foundset.newRecord()}')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newGlobalVariable
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable

Unknown macro: {span}

newGlobalVariable

Unknown macro: {span}

(scopeName, name, type)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {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.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSVariable – a JSVariable object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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.
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newListForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSList

Unknown macro: {span}

newListForm

Unknown macro: {span}

(formName, dataSource, textDataProviderID)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {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.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSList – the newly created list form.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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(); }");
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeForm

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Removes the specified form during the persistent connected client session.

NOTE: Make sure you call history.remove first in your Servoy method (script).

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//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')
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeGlobalMethod
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeGlobalMethod

Unknown macro: {span}

(scopeName, name)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Removes the specified global method.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if the removal was successful, false otherwise

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeGlobalVariable
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeGlobalVariable

Unknown macro: {span}

(scopeName, name)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Removes the specified global variable.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if the removal was successful, false otherwise

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
revertForm
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSForm

Unknown macro: {span}

revertForm

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {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.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSForm – a JSForm object

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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();
Unknown macro: {tr}
Unknown macro: {td}
  • No labels