Child pages
  • JSForm

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay: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
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
dataSource
The names of the database server and table that this form is linked to.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
name
The name of the form.
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
navigator
The navigator is a form that usually handles navigation in application.
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
onHide
The method that is triggered when another form is being activated.
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
onLoad
The method that is triggered when a form is loaded/reloaded from the repository; used to alter elements, set globals, hide toolbars,
etc; onShow method can also be assigned.
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
onRecordSelection
The method that is triggered each time a record is selected.
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
onShow
The method that is triggered EVERY TIME the form is displayed; an argument must be passed to the method if this is the first time the form is displayed.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
serverName
Get the server name used by this form.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
tableName
The [name of the table/SQL view].



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
JSBean
Table Cell (td)
getBean(name)
Returns a JSBean that has the given name.
Table Row (tr)
Table Cell (td)
JSButton
Table Cell (td)
getButton(name)
Returns a JSButton that has the given name.
Table Row (tr)
Table Cell (td)
JSButton[]
Table Cell (td)
getButtons()
Returns all JSButtons of this form, including the ones without a name.
Table Row (tr)
Table Cell (td)
JSComponent
Table Cell (td)
getComponent(name)
Returns a JSComponent that has the given name; if found it will be a JSField, JSLabel, JSButton, JSPortal, JSBean or JSTabPanel.
Table Row (tr)
Table Cell (td)
JSComponent[]
Table Cell (td)
getComponents()
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean or JSTabPanel.
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
getField(name)
The field with the specified name.
Table Row (tr)
Table Cell (td)
JSField[]
Table Cell (td)
getFields()
Returns all JSField objects of this form, including the ones without a name.
Table Row (tr)
Table Cell (td)
JSFooter
Table Cell (td)
getFooter()
Get the Footer part on the form if it exists.
Table Row (tr)
Table Cell (td)
JSHeader
Table Cell (td)
getHeader()
Get the Header part on the form if it exists.
Table Row (tr)
Table Cell (td)
JSInsetList
Table Cell (td)
getInsetList(name)
Returns an existing inset list.
Table Row (tr)
Table Cell (td)
JSInsetList[]
Table Cell (td)
getInsetLists()
Gets all insets lists on the form.
Table Row (tr)
Table Cell (td)
JSLabel
Table Cell (td)
getLabel(name)
Returns a JSLabel that has the given name.
Table Row (tr)
Table Cell (td)
JSLabel[]
Table Cell (td)
getLabels()
Returns all JSLabels of this form (not including its super form), including the ones without a name.
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
getMethod(name)
Gets an existing form method for the given name.
Table Row (tr)
Table Cell (td)
JSMethod[]
Table Cell (td)
getMethods()
Returns all existing form methods for this form.
Table Row (tr)
Table Cell (td)
JSVariable
Table Cell (td)
getVariable(name)
Gets an existing form variable for the given name.
Table Row (tr)
Table Cell (td)
JSVariable[]
Table Cell (td)
getVariables()
An array consisting of all form variables for this form.
Table Row (tr)
Table Cell (td)
JSBean
Table Cell (td)
newBean(name, y)
Creates a new JSBean object on the form.
Table Row (tr)
Table Cell (td)
JSButton
Table Cell (td)
newButton(txt, y, jsmethod)
Creates a new button on the form with the given text.
Table Row (tr)
Table Cell (td)
JSCalendar
Table Cell (td)
newCalendar(dataprovider, y)
Creates a new JSCalendar field on the form.
Table Row (tr)
Table Cell (td)
JSCalendar
Table Cell (td)
newCalendar(dataprovider, y)
Creates a new JSCalendar field on the form.
Table Row (tr)
Table Cell (td)
JSChecks
Table Cell (td)
newCheck(dataprovider, y)
Creates a new JSChecks field on the form.
Table Row (tr)
Table Cell (td)
JSChecks
Table Cell (td)
newCheck(dataprovider, y)
Creates a new JSChecks field on the form.
Table Row (tr)
Table Cell (td)
JSCombobox
Table Cell (td)
newCombobox(dataprovider, y)
Creates a new JSCombobox field on the form.
Table Row (tr)
Table Cell (td)
JSCombobox
Table Cell (td)
newCombobox(dataprovider, y)
Creates a new JSCombobox field on the form.
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
newField(dataprovider, type, y)
Creates a new JSField object on the form .
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
newField(dataprovider, type, y)
Creates a new JSField object on the form .
Table Row (tr)
Table Cell (td)
JSFooter
Table Cell (td)
newFooter()
Creates a new Footer part on the form.
Table Row (tr)
Table Cell (td)
JSHeader
Table Cell (td)
newHeader()
Creates a new Header part on the form.
Table Row (tr)
Table Cell (td)
JSInsetList
Table Cell (td)
newInsetList(yLocation, relationName, headerText, textDataProviderID)
Creates a new inset list mobile component in the given form.
Table Row (tr)
Table Cell (td)
JSLabel
Table Cell (td)
newLabel(txt, y)
Creates a new JSLabel object on the form.
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
newMethod(code)
Creates a new form JSMethod - based on the specified code.
Table Row (tr)
Table Cell (td)
JSPassword
Table Cell (td)
newPassword(dataprovider, y)
Creates a new JSPassword field on the form.
Table Row (tr)
Table Cell (td)
JSPassword
Table Cell (td)
newPassword(dataprovider, y)
Creates a new JSPassword field on the form.
Table Row (tr)
Table Cell (td)
JSRadios
Table Cell (td)
newRadios(dataprovider, y)
Creates a new JSRadios field on the form.
Table Row (tr)
Table Cell (td)
JSRadios
Table Cell (td)
newRadios(dataprovider, y)
Creates a new JSRadios field on the form.
Table Row (tr)
Table Cell (td)
JSTextArea
Table Cell (td)
newTextArea(dataprovider, y)
Creates a new JSTextArea field on the form.
Table Row (tr)
Table Cell (td)
JSTextArea
Table Cell (td)
newTextArea(dataprovider, y)
Creates a new JSTextArea field on the form.
Table Row (tr)
Table Cell (td)
JSText
Table Cell (td)
newTextField(dataprovider, y)
Creates a new JSText field on the form.
Table Row (tr)
Table Cell (td)
JSText
Table Cell (td)
newTextField(dataprovider, y)
Creates a new JSText field on the form.
Table Row (tr)
Table Cell (td)
JSVariable
Table Cell (td)
newVariable(name, type)
Creates a new form JSVariable - based on the name of the variable object and the number type, uses the SolutionModel JSVariable constants.
Table Row (tr)
Table Cell (td)
JSVariable
Table Cell (td)
newVariable(name, type, defaultValue)
Creates a new form JSVariable - based on the name of the variable object , the type and it's default value , uses the SolutionModel JSVariable constants.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeBean(name)
Removes a JSBean that has the specified name.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeButton(name)
Removes a JSButton that has the specified name.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeComponent(name)
Removes a component (JSLabel, JSButton, JSField, JSPortal, JSBean, JSTabpanel) that has the given name.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeField(name)
Removes a JSField that has the given name.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeFooter()
Removes a JSFooter if it exists.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeHeader()
Removes a JSHeader if it exists.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeInsetList(name)
Removes inset list from the form.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeLabel(name)
Removes a JSLabel that has the given name.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeMethod(name)
Removes a form JSMethod - based on the specified code.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
removeVariable(name)
Removes a form JSVariable - based on the name of the variable object.



HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Details
Table Body (tbody)
iddataSource
Table Row (tr)
idname
Table Cell (td)

dataSource

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The names of the database server and table that this form is linked to.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var myForm = solutionModel.newForm('newForm', 'db:/a_server/a_table', 'aStyleName', false, 800, 600)
myForm.dataSource = 'db:/anotherServerName/anotherTableName'
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idname
Table Row (tr)
idname
Table Cell (td)

name

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('myForm',myDatasource,null,true,800,600);
var formName = form.name;
application.output(formName);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnavigator
Table Row (tr)
idname
Table Cell (td)

navigator

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The navigator is a form that usually handles navigation in application. It is displayed on left side of the screen. Can also have value SM_DEFAULTS.NONE (no navigator) or SM_DEFAULTS.IGNORE (reuse current form navigator).
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var aForm = solutionModel.newForm('newForm1', myDatasource);
// you can also use SM_DEFAULTS.INGORE to just reuse the navigator that is already set.
// here we assign an other new form as the navigator.
var aNavigator = solutionModel.newForm('navForm', myDatasource);
aForm.navigator = aNavigator;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idonHide
Table Row (tr)
idname
Table Cell (td)

onHide

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when another form is being activated.
NOTE: If the onHide method returns false, the form can be prevented from hiding.
For example, when using onHide with showFormInDialog, the form will not close by clicking the dialog close box (X).
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSMethod
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
form.onShow = form.newMethod('function onShow(firstShow, event) { application.output("onShow intercepted on " + event.getFormName() + ". first show? " + firstShow); return false; }');
form.onHide = form.newMethod('function onHide(event) { application.output("onHide blocked on " + event.getFormName()); return false; }');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idonLoad
Table Row (tr)
idname
Table Cell (td)

onLoad

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when a form is loaded/reloaded from the repository; used to alter elements, set globals, hide toolbars,
etc; onShow method can also be assigned.
NOTE: onShow should be used to access current foundset dataproviders; onLoad cannot be used because the foundset data is not loaded until after the form is loaded.
Also calls to loadRecords() should be done in the onShow method and not in the onLoad method
If you call loadRecords() in the onShow method, you may want to set the namedFoundSet property of the form to 'empty' to prevent the first default form query.
NOTE: the onLoad event bubbles down, meaning that the onLoad is first fired on the parent then on a tab in a tabpanel (and in tab of that tab panels if you are 3 deep)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSMethod
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
form.onLoad = form.newMethod('function onLoad(event) { application.output("onLoad intercepted on " + event.getFormName()); }');
form.onUnLoad = form.newMethod('function onUnLoad(event) { application.output("onUnLoad intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idonRecordSelection
Table Row (tr)
idname
Table Cell (td)

onRecordSelection

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered each time a record is selected.
If a form is in List view or Special table view - when the user clicks on it.
In Record view - after the user navigates to another record using the slider or clicks up or down for next/previous record.
NOTE: Data and Servoy tag values are returned when the onRecordSelection method is executed.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSMethod
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
form.onRecordEditStart = form.newMethod('function onRecordEditStart(event) { application.output("onRecordEditStart intercepted on " + event.getFormName()); }');
form.onRecordEditStop = form.newMethod('function onRecordEditStop(record, event) { application.output("onRecordEditStop intercepted on " + event.getFormName() + ". record is: " + record); }');
form.onRecordSelection = form.newMethod('function onRecordSelection(event) { application.output("onRecordSelection intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idonShow
Table Row (tr)
idname
Table Cell (td)

onShow

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

The method that is triggered EVERY TIME the form is displayed; an argument must be passed to the method if this is the first time the form is displayed.

NOTE: onShow can be used to access current foundset dataproviders; onLoad cannot be used because the foundset data is not loaded until after the form is loaded.

NOTE: the onShow event bubbles down, meaning that the onShow event of a form displayed in a tabPanel is fired after the onShow event of the parent.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSMethod
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
form.onShow = form.newMethod('function onShow(firstShow, event) { application.output("onShow intercepted on " + event.getFormName() + ". first show? " + firstShow); return false; }');
form.onHide = form.newMethod('function onHide(event) { application.output("onHide blocked on " + event.getFormName()); return false; }');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idserverName
Table Row (tr)
idname
Table Cell (td)

serverName

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the server name used by this form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('myForm',myDatasource,null,true,800,600);
form.serverName = 'anotherServerName';
var theServerName = form.serverName;
application.output(theServerName);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtableName
Table Row (tr)
idname
Table Cell (td)

tableName

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The [name of the table/SQL view].[the name of the database server connection] the form is based on.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var aForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
aForm.tableName = 'anotherTableOfMine'
if (forms['newForm1'].controller.find())
{
	columnTextDataProvider = '=aSearchedValue'
	columnNumberDataProvider = '>10';
	forms['newForm1'].controller.search()
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idgetBean-String
Table Row (tr)
idname
Table Cell (td)

getBean

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSBean
Span
stylefont-weight: bold;
getBean
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a JSBean that has the given name.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the bean
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSBean - a JSBean object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var btn = myForm.getBean("mybean");
application.output(mybean.className);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetButton-String
Table Row (tr)
idname
Table Cell (td)

getButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSButton
Span
stylefont-weight: bold;
getButton
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a JSButton that has the given name.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the button
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSButton - a JSButton object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var btn = myForm.getButton("hello");
application.output(btn.text);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetButtons
Table Row (tr)
idname
Table Cell (td)

getButtons

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSButton[]
Span
stylefont-weight: bold;
getButtons
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns all JSButtons of this form, including the ones without a name.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSButton[] - the list of all JSbuttons on this forms
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var buttons = myForm.getButtons();
for (var b in buttons)
{
	if (buttons[b].name != null)
		application.output(buttons[b].name);
	else
		application.output(buttons[b].text + " has no name ");
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetComponent-String
Table Row (tr)
idname
Table Cell (td)

getComponent

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSComponent
Span
stylefont-weight: bold;
getComponent
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a JSComponent that has the given name; if found it will be a JSField, JSLabel, JSButton, JSPortal, JSBean or JSTabPanel.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the component
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSComponent - a JSComponent object (might be a JSField, JSLabel, JSButton, JSPortal, JSBean or JSTabPanel)
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
var cmp = frm.getComponent("componentName");
application.output("Component type and name: " + cmp);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetComponents
Table Row (tr)
idname
Table Cell (td)

getComponents

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSComponent[]
Span
stylefont-weight: bold;
getComponents
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean or JSTabPanel.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSComponent[] - an array of all the JSComponents on the form.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm("myForm");
var components = form.getComponents();
for (var i in components)
	application.output("Component type and name: " + components[i]);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetField-String
Table Row (tr)
idname
Table Cell (td)

getField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSField
Span
stylefont-weight: bold;
getField
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The field with the specified name.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the field
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSField - a JSField object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm("myForm");
var field = form.getField("myField");
application.output(field.dataProviderID);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetFields
Table Row (tr)
idname
Table Cell (td)

getFields

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSField[]
Span
stylefont-weight: bold;
getFields
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns all JSField objects of this form, including the ones without a name.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSField[] - all JSField objects of this form
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
var fields = frm.getFields();
for (var f in fields)
{
	var fname = fields[f].name;
	if (fname != null)
		application.output(fname);
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetFooter
Table Row (tr)
idname
Table Cell (td)

getFooter

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSFooter
Span
stylefont-weight: bold;
getFooter
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the Footer part on the form if it exists.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSFooter - A JSFooter or null when not found.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var footer = form.getFooter();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetHeader
Table Row (tr)
idname
Table Cell (td)

getHeader

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSHeader
Span
stylefont-weight: bold;
getHeader
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the Header part on the form if it exists.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSHeader - A JSHeader or null when not found.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var header = form.getHeader();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetInsetList-String
Table Row (tr)
idname
Table Cell (td)

getInsetList

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSInsetList
Span
stylefont-weight: bold;
getInsetList
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an existing inset list.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the inset list's name.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSInsetList - the existing inset list, or null if it does not exist.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm("myform");
var insetList = form.getInsetList('mylist1');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetInsetLists
Table Row (tr)
idname
Table Cell (td)

getInsetLists

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSInsetList[]
Span
stylefont-weight: bold;
getInsetLists
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets all insets lists on the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSInsetList[]
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('test');
var insetLists = form.getInsetLists();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetLabel-String
Table Row (tr)
idname
Table Cell (td)

getLabel

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSLabel
Span
stylefont-weight: bold;
getLabel
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns a JSLabel that has the given name.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the label
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSLabel - a JSLabel object (or null if the label with the specified name does not exist)
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
var label = frm.getLabel("myLabel");
application.output(label.text);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetLabels
Table Row (tr)
idname
Table Cell (td)

getLabels

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSLabel[]
Span
stylefont-weight: bold;
getLabels
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns all JSLabels of this form (not including its super form), including the ones without a name.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSLabel[] - all JSLabels on this form
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
var labels = frm.getLabels();
for (var i in labels)
{
	var lname = labels[i].name;
	if (lname != null)
		application.output(lname);
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetMethod-String
Table Row (tr)
idname
Table Cell (td)

getMethod

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSMethod
Span
stylefont-weight: bold;
getMethod
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets an existing form method for the given name.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the method
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSMethod - a JSMethod object (or null if the method with the specified name does not exist)
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
var method = frm.getMethod("myMethod");
application.output(method.code);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetMethods
Table Row (tr)
idname
Table Cell (td)

getMethods

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSMethod[]
Span
stylefont-weight: bold;
getMethods
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns all existing form methods for this form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSMethod[] - all form methods for the form
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
var methods = frm.getMethods();
for (var m in methods)
	application.output(methods[m].getName());
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetVariable-String
Table Row (tr)
idname
Table Cell (td)

getVariable

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSVariable
Span
stylefont-weight: bold;
getVariable
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets an existing form variable for the given name.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the 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 frm = solutionModel.getForm("myForm");
	var fvariable = frm.getVariable("myVarName");
	application.output(fvariable.name + " has the default value of " + fvariable.defaultValue);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetVariables
Table Row (tr)
idname
Table Cell (td)

getVariables

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSVariable[]
Span
stylefont-weight: bold;
getVariables
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
An array consisting of all form variables for this form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSVariable[] - an array of all variables on this form
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
var variables = frm.getVariables();
for (var i in variables)
	application.output(variables[i].name);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewBean-String_Number
Table Row (tr)
idname
Table Cell (td)

newBean

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSBean
Span
stylefont-weight: bold;
newBean
Span
(name, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSBean object on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the JSBean object
{Number} y - the vertical "y" position of the JSBean object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSBean - a JSBean object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', 'db:/server1/table1');
var bean = form.newBean('bean', 1);
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewButton-String_Number_JSMethod
Table Row (tr)
idname
Table Cell (td)

newButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSButton
Span
stylefont-weight: bold;
newButton
Span
(txt, y, jsmethod)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new button on the form with the given text.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} txt - the text on the button
{Number} y - the y coordinate of the button location on the form, defines the order of elements on the form
{JSMethod} jsmethod - the method assigned to handle an onAction event
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSButton - a new JSButton object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', myDatasource);
var method = form.newMethod('function onAction(event) { application.output("onAction intercepted on " + event.getFormName()); }');
var button = form.newButton('myButton', 1, method);
application.output("The new button: " + button.name + " has the following onAction event handling method assigned " + button.onAction.getName());
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewCalendar-JSVariable_Number
Table Row (tr)
idname
Table Cell (td)

newCalendar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSCalendar
Span
stylefont-weight: bold;
newCalendar
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSCalendar field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSVariable} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSCalendar - a new JSCalendar field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal', JSVariable.DATETIME);
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar', JSVariable.DATETIME);
var field = form.newCalendar(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewCalendar-String_Number
Table Row (tr)
idname
Table Cell (td)

newCalendar

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSCalendar
Span
stylefont-weight: bold;
newCalendar
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSCalendar field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSCalendar - a new JSCalendar field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal', JSVariable.DATETIME);
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar', JSVariable.DATETIME);
var field = form.newCalendar(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewCheck-JSVariable_Number
Table Row (tr)
idname
Table Cell (td)

newCheck

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSChecks
Span
stylefont-weight: bold;
newCheck
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSChecks field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSVariable} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSChecks - a new JSChecks field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.INTEGER);
//x.defaultValue = "'1'";
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.INTEGER);
//x.defaultValue = "'1'";
var field = form.newCheck(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewCheck-String_Number
Table Row (tr)
idname
Table Cell (td)

newCheck

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSChecks
Span
stylefont-weight: bold;
newCheck
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSChecks field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSChecks - a new JSChecks field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.INTEGER);
//x.defaultValue = "'1'";
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.INTEGER);
//x.defaultValue = "'1'";
var field = form.newCheck(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewCombobox-JSVariable_Number
Table Row (tr)
idname
Table Cell (td)

newCombobox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSCombobox
Span
stylefont-weight: bold;
newCombobox
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSCombobox field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSVariable} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSCombobox - a new JSCombobox field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
//x.defaultValue = "'Text from a global variable'";
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.TEXT);
//x.defaultValue = "'Text from a form variable'";
var field = form.newCombobox(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewCombobox-String_Number
Table Row (tr)
idname
Table Cell (td)

newCombobox

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSCombobox
Span
stylefont-weight: bold;
newCombobox
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSCombobox field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSCombobox - a new JSCombobox field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
//x.defaultValue = "'Text from a global variable'";
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.TEXT);
//x.defaultValue = "'Text from a form variable'";
var field = form.newCombobox(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewField-JSVariable_Number_Number
Table Row (tr)
idname
Table Cell (td)

newField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSField
Span
stylefont-weight: bold;
newField
Span
(dataprovider, type, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSField object on the form .
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSVariable} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} type - the display type of the JSField object (see the Solution Model -> JSField node for display types)
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSField
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var variable = form.newVariable('myVar', JSVariable.TEXT);
variable.defaultValue = "'This is a default value (with triple quotes)!'";
var field = form.newField(variable, JSField.TEXT_FIELD, 1);
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewField-String_Number_Number
Table Row (tr)
idname
Table Cell (td)

newField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSField
Span
stylefont-weight: bold;
newField
Span
(dataprovider, type, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSField object on the form .
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} type - the display type of the JSField object (see the Solution Model -> JSField node for display types)
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSField
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var variable = form.newVariable('myVar', JSVariable.TEXT);
variable.defaultValue = "'This is a default value (with triple quotes)!'";
var field = form.newField(variable, JSField.TEXT_FIELD, 1);
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewFooter
Table Row (tr)
idname
Table Cell (td)

newFooter

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSFooter
Span
stylefont-weight: bold;
newFooter
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new Footer part on the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSFooter - A JSFooter instance corresponding to the newly created Footer form part.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var footer = form.newFooter();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewHeader
Table Row (tr)
idname
Table Cell (td)

newHeader

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSHeader
Span
stylefont-weight: bold;
newHeader
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new Header part on the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSHeader - A JSHeader instance corresponding to the newly created Header form part.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var header = form.newHeader();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewInsetList-Number_String_String_String
Table Row (tr)
idname
Table Cell (td)

newInsetList

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSInsetList
Span
stylefont-weight: bold;
newInsetList
Span
(yLocation, relationName, headerText, textDataProviderID)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new inset list mobile component in the given form. The inset list will be populated based on the given datasource and relation.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} yLocation - the vertical location of the inset list in the form's components list.
{String} relationName - the relation used to show data, just like it would happen in a related tab-panel.
{String} headerText - can be null; it's a convenience argument for setting the title (header text) for the inset list.
{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
JSInsetList - the newly created inset list.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var f = solutionModel.newForm("created_by_sm_1","db:/udm/contacts");
// create an inset list
var insetList = f.newInsetList(8,"accountmanager_to_companies","Companies","company_name");
insetList.subtextDataProviderID = "company_description";
insetList.onAction = f.newMethod("function buttonPressed() { plugins.dialogs.showWarningDialog('Title', 'inset list clicked','OK'); }");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewLabel-String_Number
Table Row (tr)
idname
Table Cell (td)

newLabel

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSLabel
Span
stylefont-weight: bold;
newLabel
Span
(txt, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSLabel object on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} txt - the specified text of the label object
{Number} y - the vertical "y" position of the label, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSLabel - a JSLabel object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', myDatasource);
var label = form.newLabel('The text on the label', 1);
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewMethod-String
Table Row (tr)
idname
Table Cell (td)

newMethod

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSMethod
Span
stylefont-weight: bold;
newMethod
Span
(code)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new form JSMethod - based on the specified code.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} code - the specified code for the new method
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSMethod - a new JSMethod object for this form
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var method = form.newMethod('function aMethod(event){application.output("Hello world!");}');
var button = myListViewForm.newButton('Show message!',50,50,100,30,method);
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewPassword-JSVariable_Number
Table Row (tr)
idname
Table Cell (td)

newPassword

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSPassword
Span
stylefont-weight: bold;
newPassword
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSPassword field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSVariable} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSPassword - a new JSPassword field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.TEXT);
var field = form.newPassword(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewPassword-String_Number
Table Row (tr)
idname
Table Cell (td)

newPassword

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSPassword
Span
stylefont-weight: bold;
newPassword
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSPassword field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSPassword - a new JSPassword field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.TEXT);
var field = form.newPassword(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewRadios-JSVariable_Number
Table Row (tr)
idname
Table Cell (td)

newRadios

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSRadios
Span
stylefont-weight: bold;
newRadios
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSRadios field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSVariable} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSRadios - a new JSRadios field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
//x.defaultValue = "'Text from a global variable'";
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.TEXT);
//x.defaultValue = "'Text from a form variable'";
var field = form.newRadios(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewRadios-String_Number
Table Row (tr)
idname
Table Cell (td)

newRadios

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSRadios
Span
stylefont-weight: bold;
newRadios
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSRadios field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSRadios - a new JSRadios field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
//x.defaultValue = "'Text from a global variable'";
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.TEXT);
//x.defaultValue = "'Text from a form variable'";
var field = form.newRadios(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewTextArea-JSVariable_Number
Table Row (tr)
idname
Table Cell (td)

newTextArea

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSTextArea
Span
stylefont-weight: bold;
newTextArea
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSTextArea field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSVariable} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSTextArea - a new JSTextArea field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
//x.defaultValue = "'Text from a global variable'";
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.TEXT);
//x.defaultValue = "'Text from a form variable'";
var field = form.newTextArea(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewTextArea-String_Number
Table Row (tr)
idname
Table Cell (td)

newTextArea

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSTextArea
Span
stylefont-weight: bold;
newTextArea
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSTextArea field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSTextArea - a new JSTextArea field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
//x.defaultValue = "'Text from a global variable'";
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.TEXT);
//x.defaultValue = "'Text from a form variable'";
var field = form.newTextArea(x,1);
//or a column data provider as the dataprovider
//field.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewTextField-JSVariable_Number
Table Row (tr)
idname
Table Cell (td)

newTextField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSText
Span
stylefont-weight: bold;
newTextField
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSText field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSVariable} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSText - a new JSText field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the Text Field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
//x.defaultValue = "'Text from a global variable'";
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.TEXT);
//x.defaultValue = "'Text from a form variable'";
var textField = form.newTextField(x,1);
//or a column data provider as the dataprovider
//textField.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewTextField-String_Number
Table Row (tr)
idname
Table Cell (td)

newTextField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSText
Span
stylefont-weight: bold;
newTextField
Span
(dataprovider, y)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new JSText field on the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} y - the vertical "y" position of the JSField object, defines the order of elements on the form
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSText - a new JSText field
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1',myDatasource);
//choose the dataprovider or JSVariable you want for the Text Field
var x = null;
//global JSVariable as the dataprovider
//x = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
//x.defaultValue = "'Text from a global variable'";
//or a form JSVariable as the dataprovider
//x = form.newVariable('myFormVar',JSVariable.TEXT);
//x.defaultValue = "'Text from a form variable'";
var textField = form.newTextField(x,1);
//or a column data provider as the dataprovider
//textField.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewVariable-String_Number
Table Row (tr)
idname
Table Cell (td)

newVariable

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSVariable
Span
stylefont-weight: bold;
newVariable
Span
(name, type)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Creates a new form JSVariable - based on the name of the variable object and the number type, uses the SolutionModel JSVariable constants.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the variable
{Number} type - the specified type of the variable (see Solution Model -> JSVariable node constants)
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 form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var variable = form.newVariable('myVar', JSVariable.TEXT , "'This is a default value (with triple quotes)!'");
//or variable = form.newVariable('myVar', JSVariable.TEXT)
//variable.defaultValue = "'This is a default value (with triple quotes)!'" // setting the default value after the variable is created requires form recreation
//variable.defaultValue = "{a:'First letter',b:'Second letter'}"
var field = form.newField(variable, JSField.TEXT_FIELD, 100, 100, 200, 200);
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewVariable-String_Number_String
Table Row (tr)
idname
Table Cell (td)

newVariable

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSVariable
Span
stylefont-weight: bold;
newVariable
Span
(name, type, defaultValue)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Creates a new form JSVariable - based on the name of the variable object , the type and it's default value , uses the SolutionModel JSVariable constants.

This method does not require the form to be destroyed and recreated. Use this method if you want to change the form's model without destroying the runtime form</b>

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the variable
{Number} type - the specified type of the variable (see Solution Model -> JSVariable node constants)
{String} defaultValue - the default value as a javascript expression string
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 form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var variable = form.newVariable('myVar', JSVariable.TEXT , "'This is a default value (with triple quotes)!'");
//or variable = form.newVariable('myVar', JSVariable.TEXT)
//variable.defaultValue = "'This is a default value (with triple quotes)!'" // setting the default value after the variable is created requires form recreation
//variable.defaultValue = "{a:'First letter',b:'Second letter'}"
var field = form.newField(variable, JSField.TEXT_FIELD, 100, 100, 200, 200);
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveBean-String
Table Row (tr)
idname
Table Cell (td)

removeBean

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeBean
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes a JSBean that has the specified name. Returns true if removal was successful, false otherwise.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the JSBean to be removed
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if the JSBean has been removed; false otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('myform');
form.removeBean('mybean')
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveButton-String
Table Row (tr)
idname
Table Cell (td)

removeButton

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeButton
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes a JSButton that has the specified name. Returns true if removal was successful, false otherwise.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the JSButton to be removed
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if the JSButton has been removed; false otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newFormX',myDatasource,null,true,800,600);
var b1 = form.newButton('This is button1',100,100,200,50,null);
b1.name = 'b1';
var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX'); if (form.removeButton('b1') == true) application.output('Button has been removed ok'); else application.output('Button could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var b2 = form.newButton('Click here to remove button1',100,230,200,50,jsmethod);
b2.name = 'b2';
forms['newFormX'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveComponent-String
Table Row (tr)
idname
Table Cell (td)

removeComponent

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeComponent
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes a component (JSLabel, JSButton, JSField, JSPortal, JSBean, JSTabpanel) that has the given name. It is the same as calling "if(!removeLabel(name) && !removeButton(name) ....)".
Returns true if removal was successful, false otherwise.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the component to be deleted
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if component has been successfully deleted; false otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newFormX','db:/server1/parent_table',null,true,1000,750);
var jsbutton = form.newButton('JSButton to delete',100,100,200,50,null);
jsbutton.name = 'jsb';
var jslabel = form.newLabel('JSLabel to delete',100,200,200,50,null);
jslabel.name = 'jsl';
jslabel.transparent = false;
jslabel.background = 'green';
var jsfield = form.newField('scopes.globals.myGlobalVariable',JSField.TEXT_FIELD,100,300,200,50);
jsfield.name = 'jsf';
var relation = solutionModel.newRelation('parentToChild','db:/server1/parent_table','db:/server1/child_table',JSRelation.INNER_JOIN);
relation.newRelationItem('parent_table_id', '=', 'child_table_id');
var jsportal = form.newPortal('jsp',relation,100,400,300,300);
jsportal.newField('child_table_id',JSField.TEXT_FIELD,200,200,120);
var childOne = solutionModel.newForm('childOne','db:/server1/child_table',null,false,400,300);
childOne.newField('child_table_id', JSField.TEXT_FIELD,10,10,100,20);
var childTwo = solutionModel.newForm('childTwo','server1','other_table',null,false,400,300);
childTwo.newField('some_table_id', JSField.TEXT_FIELD,10,10,100,100);
var jstabpanel = form.newTabPanel('jst',450,30,620,460);
jstabpanel.newTab('tab1','Child One',childOne,relation);
jstabpanel.newTab('tab2','Child Two',childTwo);
var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if ((form.removeComponent('jsb') == true) && (form.removeComponent('jsl') == true) && (form.removeComponent('jsf') == true) && (form.removeComponent('jsp') == true) & (form.removeComponent('jst') == true)) application.output('Components removed ok'); else application.output('Some component(s) could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var removerButton = form.newButton('Click here to remove form components',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveField-String
Table Row (tr)
idname
Table Cell (td)

removeField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeField
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes a JSField that has the given name. Returns true if removal was successful, false otherwise.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the JSField to remove
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true is the JSField has been successfully removed; false otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newFormX',myDatasource,null,true,800,600);
var jsfield = form.newField(scopes.globals.myGlobalVariable,JSField.TEXT_FIELD,100,300,200,50);
jsfield.name = 'jsf';
var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if (form.removeComponent('jsf') == true) application.output('Field has been removed ok'); else application.output('Field could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var removerButton = form.newButton('Click here to remove the field',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveFooter
Table Row (tr)
idname
Table Cell (td)

removeFooter

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeFooter
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes a JSFooter if it exists.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if the JSFooter has successfully been removed; false otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('myform');
form.removeFooter()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveHeader
Table Row (tr)
idname
Table Cell (td)

removeHeader

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeHeader
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes a JSHeader if it exists.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if the JSHeader has successfully been removed; false otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('myform');
form.removeHeader()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveInsetList-String
Table Row (tr)
idname
Table Cell (td)

removeInsetList

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeInsetList
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes inset list from the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - Inset List name.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm('test');
form.removeInsetList('myinsetlist');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveLabel-String
Table Row (tr)
idname
Table Cell (td)

removeLabel

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeLabel
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes a JSLabel that has the given name. Returns true if removal successful, false otherwise
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the JSLabel to be removed
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if the JSLabel with the given name has successfully been removed; false otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newFormX',myDatasource,null,true,1000,750);
var jslabel = form.newLabel('JSLabel to delete',100,200,200,50,null);
jslabel.name = 'jsl';
jslabel.transparent = false;
jslabel.background = 'green';
var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX'); if (form.removeComponent('jsl') == true) application.output('Label has been removed'); else application.output('Label could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var removerButton = form.newButton('Click here to remove the green label',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveMethod-String
Table Row (tr)
idname
Table Cell (td)

removeMethod

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeMethod
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes a form JSMethod - based on the specified code.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the method
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if method was removed successfully , false otherwise
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', null, null, true, 800, 600);
var hello = form.newMethod('function aMethod(event){application.output("Hello world!");}');
var removeMethod = form.newMethod('function removeMethod(event){ \
									solutionModel.getForm(event.getFormName()).removeMethod("aMethod"); \
									forms[event.getFormName()].controller.recreateUI();\
									}');
var button1 = form.newButton('Call method!',50,50,120,30,hello);
var button2 = form.newButton('Remove Mehtod!',200,50,120,30,removeMethod);
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idremoveVariable-String
Table Row (tr)
idname
Table Cell (td)

removeVariable

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
removeVariable
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Removes a form JSVariable - based on the name of the variable object.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the specified name of the variable
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if removed, false otherwise (ex: no var with that name)
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('newForm1', null, null, true, 800, 600);
var variable = form.newVariable('myVar', JSVariable.TEXT);
variable.defaultValue = "'This is a default value (with triple quotes)!'";
//variable.defaultValue = "{a:'First letter',b:'Second letter'}"
var field = form.newField(variable, JSField.TEXT_FIELD, 100, 100, 200, 200);
forms['newForm1'].controller.show();

variable = form.removeVariable('myVar');
application.sleep(4000);
forms['newForm1'].controller.recreateUI();
Table Row (tr)
classlastDetailRow
Table Cell (td)