Page History

Div

style	display:none

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

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
EMPTY_FOUNDSET Constant used for form namedFoundset property.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
LIST_VIEW The constants to set or get the view property of a JSForm.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
LOCKED_LIST_VIEW The constants to set or get the view property of a JSForm.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
LOCKED_RECORD_VIEW The constants to set or get the view property of a JSForm.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
LOCKED_TABLE_VIEW The constants to set or get the view property of a JSForm.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
RECORD_VIEW The constants to set or get the view property of a JSForm.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
SELECTION_MODE_DEFAULT Constant used for form selectionMode property.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
SELECTION_MODE_MULTI Constant used for form selectionMode property.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
SELECTION_MODE_SINGLE Constant used for form selectionMode property.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
SEPARATE_FOUNDSET Constant used for form namedFoundset property.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
borderType The type, color and style of border of the component.

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)
defaultPageFormat The default page format for the form.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
encapsulation Get or set the encapsulation level for the form.

Table Row (tr)

Table Cell (td)
JSForm

Table Cell (td)
extendsForm A JSForm instance representing the super form of this form, if this form has a super form.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
initialSort The default sort order only when the form loads.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
name The name of the form.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
namedFoundSet Property that tells the form to use a named foundset instead of the default foundset.

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
navigator The navigator (previously named "controller") that is used to control/navigate to the form.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onDeleteAllRecordsCmd The method that overrides the Servoy menu item Select > Delete All.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onDeleteRecordCmd The method that overrides the Servoy menu item Select > Delete Record (or keyboard shortcut).

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onDrag The method that is triggered when (non Design Mode) dragging occurs.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onDragEnd The method that is triggered when (non Design Mode) dragging end occurs.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onDragOver The method that is triggered when (non Design Mode) dragging over a component occurs.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onDrop The method that is triggered when (non Design Mode) dropping occurs.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onDuplicateRecordCmd The method that overrides the Servoy menu item Select > Duplicate Record (or keyboard shortcut).

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onElementFocusGained The method that is triggered when focus is gained by a component inside the form.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onElementFocusLost The method that gets triggered when focus is lost by a component inside the form.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onFindCmd The method that overrides the Servoy menu item Select > Find (or keyboard shortcut) in Data (ready) mode.

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)
onInvertRecordsCmd The method that overrides the Servoy menu item Select > Invert Records.

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)
onNewRecordCmd The method that overrides the Servoy menu item Select > New Record (or keyboard shortcut).

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onNextRecordCmd The method that overrides the Servoy menu item Select > Next Record.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onOmitRecordCmd The method that overrides the Servoy menu item Select > Omit Record.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onPreviousRecordCmd The method that overrides the Servoy menu item Select > Previous Record.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onPrintPreviewCmd The method that overrides the Servoy menu item File > Print Preview.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onRecordEditStart The method that is triggered when a user clicks into a column on the form.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onRecordEditStop The method that is triggered when a record is being saved.

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)
onRender The method that is executed when the component is rendered.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onResize The method that gets triggered when resize occurs.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onSearchCmd The method that overrides the Servoy menu item Select > Search (or keyboard shortcut) in Find mode.

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

Table Cell (td)
onShowAllRecordsCmd The method that overrides the Servoy menu item Select > Show All (or keyboard shortcut).

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onShowOmittedRecordsCmd The method that overrides the Servoy menu item Select > Show Omitted Records.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onSortCmd The method that overrides the Servoy menu item Select > Sort.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
onUnLoad The method that is triggered when a form is unloaded from the repository.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
paperPrintScale The percentage value the printed page is enlarged or reduced to; the size of the printed form is inversely proportional.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
scrollbars Scrollbar options for the vertical and horizontal scrollbars.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
selectionMode Returns the value of the form's selectionMode property.

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

Table Cell (td)
showInMenu When set, the form is displayed under the Window menu.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
styleClass The Cascading Style Sheet (CSS) class name applied to the form.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
styleName The name of the Servoy style that is being used on the form.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
tableName The [name of the table/SQL view].

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
titleText The text that displays in the title bar of the form window.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
transparent When set, the form is transparent.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
view The default form view mode.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
width The width of the form in pixels.

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
JSBean

Table Cell (td)
getBean(name) Returns a JSBean that has the given name.

Table Row (tr)

Table Cell (td)
JSBean[]

Table Cell (td)
getBeans() Returns all JSBeans of this form.

Table Row (tr)

Table Cell (td)
JSBean[]

Table Cell (td)
getBeans(returnInheritedElements) Returns all JSBeans of this form.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
getBodyPart() Retrieves the Body part of the form.

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)
JSButton[]

Table Cell (td)
getButtons(returnInheritedElements) 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)
JSComponent[]

Table Cell (td)
getComponents(returnInheritedElements) 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)
Object

Table Cell (td)
getDesignTimeProperty() Get a design-time property of a form.

Table Row (tr)

Table Cell (td)
String[]

Table Cell (td)
getDesignTimePropertyNames() Get the design-time properties of a form.

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)
JSField[]

Table Cell (td)
getFields(returnInheritedElements) Returns all JSField objects of this form, including the ones without a name.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
getFooterPart() Retrieves the Footer part of the form.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
getHeaderPart() Retrieves the Header part of 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)
JSLabel[]

Table Cell (td)
getLabels(returnInheritedElements) Returns all JSLabels of this form (optionally including it super forms labels), including the ones without a name.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
getLeadingGrandSummaryPart() Retrieves the Leading Grand Summary part of the form.

Table Row (tr)

Table Cell (td)
JSPart[]

Table Cell (td)
getLeadingSubSummaryParts() Gets an array of the Leading Subsummary parts of the form, ordered by their height from top == 0 to bottom.

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)
JSMethod[]

Table Cell (td)
getMethods(returnInheritedElements) Returns all existing form methods for this form.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
getPart(type) Gets a part of the form from the given type (see JSPart constants).

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
getPart(type, height) Gets a part of the form from the given type (see JSPart constants).

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getPartYOffset(type) Returns the Y offset of a given part (see JSPart) of the form.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getPartYOffset(type, height) Returns the Y offset of a given part (see JSPart) of the form.

Table Row (tr)

Table Cell (td)
JSPart[]

Table Cell (td)
getParts() Gets all the parts from the form (not including the parts of the parent form), ordered by there height (lowerbound) property, from top == 0 to bottom.

Table Row (tr)

Table Cell (td)
JSPart[]

Table Cell (td)
getParts(returnInheritedElements) Gets all the parts from the form (optionally also from the parent form), ordered by there height (lowerbound) property, from top == 0 to bottom.

Table Row (tr)

Table Cell (td)
JSPortal

Table Cell (td)
getPortal(name) Returns a JSPortal that has the given name.

Table Row (tr)

Table Cell (td)
JSPortal[]

Table Cell (td)
getPortals() Returns all JSPortal objects of this form (not including the ones from the parent form), including the ones without a name.

Table Row (tr)

Table Cell (td)
JSPortal[]

Table Cell (td)
getPortals(returnInheritedElements) Returns all JSPortal objects of this form (optionally also the ones from the parent form), including the ones without a name.

Table Row (tr)

Table Cell (td)
JSTabPanel

Table Cell (td)
getTabPanel(name) Returns a JSTabPanel that has the given name.

Table Row (tr)

Table Cell (td)
JSTabPanel[]

Table Cell (td)
getTabPanels() Returns all JSTabPanels of this form (not including the ones from the parent form), including the ones without a name.

Table Row (tr)

Table Cell (td)
JSTabPanel[]

Table Cell (td)
getTabPanels(returnInheritedElements) Returns all JSTabPanels of this form (optionally the ones from the parent form), including the ones without a name.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
getTitleFooterPart() Retrieves the Title Footer part of the form.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
getTitleHeaderPart() Retrieves the Title Header part of the form.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
getTrailingGrandSummaryPart() Retrieves the Trailing Grand Summary part of the form.

Table Row (tr)

Table Cell (td)
JSPart[]

Table Cell (td)
getTrailingSubSummaryParts() Gets an array of the Trailing Subsummary parts of the form, ordered by their height from top == 0 to bottom.

Table Row (tr)

Table Cell (td)
UUID

Table Cell (td)
getUUID() Returns the UUID of 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)
JSVariable[]

Table Cell (td)
getVariables(returnInheritedElements) An array consisting of all form variables for this form.

Table Row (tr)

Table Cell (td)
JSBean

Table Cell (td)
newBean(name, className, x, y, width, height) Creates a new JSBean object on the form - including the name of the JSBean object; the classname the JSBean object is based on, the "x" and "y" position of the JSBean object in pixels, as well as the width and height of the JSBean object in pixels.

Table Row (tr)

Table Cell (td)
JSButton

Table Cell (td)
newButton(txt, x, y, width, height, action) Creates a new button on the form with the given text, place, size and JSMethod as the onAction event triggered action.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newCalendar(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of CALENDAR - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newCheck(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of CHECK (checkbox) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newComboBox(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of COMBOBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newField(dataprovider, type, x, y, width, height) Creates a new JSField object on the form - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
newFooterPart(height) Creates a new Footer part on the form.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
newHeaderPart(height) Creates a new Header part on the form.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newHtmlArea(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of HTML_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newImageMedia(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of IMAGE_MEDIA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSLabel

Table Cell (td)
newLabel(txt, x, y, width, height) Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels.

Table Row (tr)

Table Cell (td)
JSLabel

Table Cell (td)
newLabel(txt, x, y, width, height, action) Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels and a JSMethod action such as the method for an onAction event.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
newLeadingGrandSummaryPart(height) Creates a new Leading Grand Summary part on the form.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
newLeadingSubSummaryPart(height) Creates a new Leading Subsummary part on the form.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newListBox(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

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

Table Cell (td)
newMultiSelectListBox(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of MULTISELECT_LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
newPart(type, height) Creates a new part on the form.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newPassword(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of PASSWORD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSPortal

Table Cell (td)
newPortal(name, relation, x, y, width, height) Creates a new JSPortal object on the form - including the name of the JSPortal object; the relation the JSPortal object is based on, the "x" and "y" position of the JSPortal object in pixels, as well as the width and height of the JSPortal object in pixels.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newRadios(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of RADIOS (radio buttons) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newRtfArea(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of RTF_AREA (enables more than one line of text to be displayed in a field) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newSpinner(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of SPINNER - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSTabPanel

Table Cell (td)
newTabPanel(name, x, y, width, height) Creates a new JSTabPanel object on the form - including the name of the JSTabPanel object, the "x" and "y" position of the JSTabPanel object in pixels, as well as the width and height of the JSTabPanel object in pixels.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newTextArea(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of TEXT_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newTextField(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of TEXT_FIELD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
newTitleFooterPart(height) Creates a new Title Footer part on the form.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
newTitleHeaderPart(height) Creates a new Title Header part on the form.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
newTrailingGrandSummaryPart(height) Creates a new Trailing Grand Summary part on the form.

Table Row (tr)

Table Cell (td)
JSPart

Table Cell (td)
newTrailingSubSummaryPart(height) Creates a new Trailing Subsummary part on the form.

Table Row (tr)

Table Cell (td)
JSField

Table Cell (td)
newTypeAhead(dataprovider, x, y, width, height) Creates a new JSField object on the form with the displayType of TYPE_AHEAD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

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

Table Cell (td)
putDesignTimeProperty() Set a design-time property of a form.

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

Table Cell (td)
removeDesignTimeProperty() Clear a design-time property of a form.

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)
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)
removePart(type) Removes a JSPart of the given type.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removePart(type, height) Removes a JSPart of the given type.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removePortal(name) Removes a JSPortal that has the given name.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
removeTabPanel(name) Removes a JSTabPanel that has the given name.

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

id	constant
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Details

Table Body (tbody)

id	EMPTY_FOUNDSET

Table Row (tr)

id	name

Table Cell (td)
EMPTY_FOUNDSET

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used for form namedFoundset property. The form that uses empty namedFoundset will initially have an empty (cleared) foundset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// form with empty foundset
var frmEmpty = solutionModel.newForm('products_empty', 'example_data', 'products', null, true, 640, 480);
frmEmpty.newLabel("Empty FoundSet",10,10,200,20);
frmEmpty.newField('categoryid',JSField.TEXT_FIELD,10,40,200,20);
frmEmpty.newField('productname',JSField.TEXT_FIELD,10,70,200,20);
frmEmpty.namedFoundSet = JSForm.EMPTY_FOUNDSET;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	LIST_VIEW

Table Row (tr)

id	name

Table Cell (td)
LIST_VIEW

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The constants to set or get the view property of a JSForm.
They are as follows: JSForm.LIST_VIEW, JSForm.LOCKED_LIST_VIEW, JSForm.LOCKED_RECORD_VIEW, JSForm.LOCKED_TABLE_VIEW, JSForm.RECORD_VIEW.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myListViewForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600);
myListViewForm.view = JSForm.LIST_VIEW;

var myLockedListViewForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600);
myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW;

var myLockedRecordViewForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600);
myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW;

var myLockedTableViewForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600);
myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW;

var myRecordViewForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600);
myRecordViewForm.view = JSForm.RECORD_VIEW;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	LOCKED_LIST_VIEW

Table Row (tr)

id	name

Table Cell (td)
LOCKED_LIST_VIEW

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The constants to set or get the view property of a JSForm.
They are as follows: JSForm.LIST_VIEW, JSForm.LOCKED_LIST_VIEW, JSForm.LOCKED_RECORD_VIEW, JSForm.LOCKED_TABLE_VIEW, JSForm.RECORD_VIEW.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myListViewForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600);
myListViewForm.view = JSForm.LIST_VIEW;

var myLockedListViewForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600);
myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW;

var myLockedRecordViewForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600);
myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW;

var myLockedTableViewForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600);
myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW;

var myRecordViewForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600);
myRecordViewForm.view = JSForm.RECORD_VIEW;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	LOCKED_RECORD_VIEW

Table Row (tr)

id	name

Table Cell (td)
LOCKED_RECORD_VIEW

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The constants to set or get the view property of a JSForm.
They are as follows: JSForm.LIST_VIEW, JSForm.LOCKED_LIST_VIEW, JSForm.LOCKED_RECORD_VIEW, JSForm.LOCKED_TABLE_VIEW, JSForm.RECORD_VIEW.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myListViewForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600);
myListViewForm.view = JSForm.LIST_VIEW;

var myLockedListViewForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600);
myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW;

var myLockedRecordViewForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600);
myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW;

var myLockedTableViewForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600);
myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW;

var myRecordViewForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600);
myRecordViewForm.view = JSForm.RECORD_VIEW;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	LOCKED_TABLE_VIEW

Table Row (tr)

id	name

Table Cell (td)
LOCKED_TABLE_VIEW

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The constants to set or get the view property of a JSForm.
They are as follows: JSForm.LIST_VIEW, JSForm.LOCKED_LIST_VIEW, JSForm.LOCKED_RECORD_VIEW, JSForm.LOCKED_TABLE_VIEW, JSForm.RECORD_VIEW.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myListViewForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600);
myListViewForm.view = JSForm.LIST_VIEW;

var myLockedListViewForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600);
myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW;

var myLockedRecordViewForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600);
myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW;

var myLockedTableViewForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600);
myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW;

var myRecordViewForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600);
myRecordViewForm.view = JSForm.RECORD_VIEW;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	RECORD_VIEW

Table Row (tr)

id	name

Table Cell (td)
RECORD_VIEW

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The constants to set or get the view property of a JSForm.
They are as follows: JSForm.LIST_VIEW, JSForm.LOCKED_LIST_VIEW, JSForm.LOCKED_RECORD_VIEW, JSForm.LOCKED_TABLE_VIEW, JSForm.RECORD_VIEW.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myListViewForm = solutionModel.newForm('newForm1', myDatasource, myStyleName, false, 800, 600);
myListViewForm.view = JSForm.LIST_VIEW;

var myLockedListViewForm = solutionModel.newForm('newForm2', myDatasource, myStyleName, false, 800, 600);
myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW;

var myLockedRecordViewForm = solutionModel.newForm('newForm3', myDatasource, myStyleName, false, 800, 600);
myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW;

var myLockedTableViewForm = solutionModel.newForm('newForm4', myDatasource, myStyleName, false, 800, 600);
myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW;

var myRecordViewForm = solutionModel.newForm('newForm5', myDatasource, myStyleName, false, 800, 600);
myRecordViewForm.view = JSForm.RECORD_VIEW;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	SELECTION_MODE_DEFAULT

Table Row (tr)

id	name

Table Cell (td)
SELECTION_MODE_DEFAULT

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used for form selectionMode property. It means that the foundset's multiSelect property is used.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myForm = solutionModel.getForm('my_form_name');
myForm.selectionMode = JSForm.SELECTION_MODE_DEFAULT;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	SELECTION_MODE_MULTI

Table Row (tr)

id	name

Table Cell (td)
SELECTION_MODE_MULTI

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used for form selectionMode property. It means that the form will force multiSelect to true on the foundset it uses.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myForm = solutionModel.getForm('my_form_name');
myForm.selectionMode = JSForm.SELECTION_MODE_MULTI;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	SELECTION_MODE_SINGLE

Table Row (tr)

id	name

Table Cell (td)
SELECTION_MODE_SINGLE

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used for form selectionMode property. It means that the form will force multiSelect to false on the foundset it uses.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myForm = solutionModel.getForm('my_form_name');
myForm.selectionMode = JSForm.SELECTION_MODE_SINGLE;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	SEPARATE_FOUNDSET

Table Row (tr)

id	name

Table Cell (td)
SEPARATE_FOUNDSET

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant used for form namedFoundset property. The form that uses a separate namedFoundset will initially have an separate (not shared with other forms) foundset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// form with separate foundset
var frmSeparate = solutionModel.newForm('products_separate', 'example_data', 'products', null, true, 640, 480);
frmSeparate.newLabel("Separate FoundSet",10,10,200,20);
frmSeparate.newField('categoryid',JSField.TEXT_FIELD,10,40,200,20);
frmSeparate.newField('productname',JSField.TEXT_FIELD,10,70,200,20);
frmSeparate.namedFoundSet = JSForm.SEPARATE_FOUNDSET;
forms['products_separate'].controller.find();
forms['products_separate'].categoryid = '=2';
forms['products_separate'].controller.search();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id	borderType

Table Row (tr)

id	name

Table Cell (td)
borderType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The type, color and style of border of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//HINT: To know exactly the notation of this property set it in the designer and then read it once out through the solution model.
var field = form.newField('my_table_text', JSField.TEXT_FIELD, 10, 10, 100, 20);
field.borderType = solutionModel.createLineBorder(1,'#ff0000');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	dataSource

Table Row (tr)

id	name

Table Cell (td)
dataSource

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The names of the database server and table that this form is linked to.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myForm = solutionModel.newForm('newForm', 'db:/a_server/a_table', 'aStyleName', false, 800, 600)
myForm.dataSource = 'db:/anotherServerName/anotherTableName'

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	defaultPageFormat

Table Row (tr)

id	name

Table Cell (td)
defaultPageFormat

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The default page format for the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.getForm("someForm");
application.output(form.defaultPageFormat);
form.defaultPageFormat = solutionModel.createPageFormat(612,792,72,72,72,72,SM_ORIENTATION.PORTRAIT,SM_UNITS.PIXELS)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	encapsulation

Table Row (tr)

id	name

Table Cell (td)
encapsulation

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get or set the encapsulation level for the form.

Encapsulation is one of constants JSForm.DEFAULT_ENCAPSULATION, JSForm.PRIVATE_ENCAPSULATION, JSForm.MODULE_PRIVATE_ENCAPSULATION,
JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION, JSForm.HIDE_FOUNDSET_ENCAPSULATION, JSForm.HIDE_CONTROLLER_ENCAPSULATION or JSForm.HIDE_ELEMENTS_ENCAPSULATION

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
myForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	extendsForm

Table Row (tr)

id	name

Table Cell (td)
extendsForm

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

A JSForm instance representing the super form of this form, if this form has a super form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSForm

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var subForm = solutionModel.newForm('childForm',myDatasource,null,true,800,600);
var superForm = solutionModel.newForm('childForm',myDatasource,null,true,800,600);
subForm.extendsForm = superForm;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	initialSort

Table Row (tr)

id	name

Table Cell (td)
initialSort

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The default sort order only when the form loads.
This is applied each time an internal SQL query is being executed (find, find-all, open form); and is only executed when no other manual sort has been performed on the foundset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('myForm',myDatasource,null,true,800,600);
form.initialSort = "column1 desc, column2 asc, column3 asc";

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('myForm',myDatasource,null,true,800,600);
var formName = form.name;
application.output(formName);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	namedFoundSet

Table Row (tr)

id	name

Table Cell (td)
namedFoundSet

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Property that tells the form to use a named foundset instead of the default foundset.
When JSForm.SEPARATE_FOUNDSET is specified the form will always create a copy of assigned foundset and therefore become separated from other foundsets.
When JSForm.EMPTY_FOUNDSET, the form will have an initially empty foundset.

The namedFoundset can be based on a global relation; in this case namedFoundset is the relation's name.
You can also set the namedFoundset to a JSRelation object directly.
It will tell this form to initially load a global relation based foundset.
The global relation's foreign datasource must match the form's datasource.
Do not use relations named "empty" or "separate" to avoid confusions.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// form with separate foundset
var frmSeparate = solutionModel.newForm('products_separate', 'db:/example_data/products', null, true, 640, 480);
frmSeparate.newLabel("Separate FoundSet",10,10,200,20);
frmSeparate.newField('categoryid',JSField.TEXT_FIELD,10,40,200,20);
frmSeparate.newField('productname',JSField.TEXT_FIELD,10,70,200,20);
frmSeparate.namedFoundSet = JSForm.SEPARATE_FOUNDSET;
forms['products_separate'].controller.find();
forms['products_separate'].categoryid = '=2';
forms['products_separate'].controller.search();

// form with empty foundset
var frmEmpty = solutionModel.newForm('products_empty', 'db:/example_data/products', null, true, 640, 480);
frmEmpty.newLabel("Empty FoundSet",10,10,200,20);
frmEmpty.newField('categoryid',JSField.TEXT_FIELD,10,40,200,20);
frmEmpty.newField('productname',JSField.TEXT_FIELD,10,70,200,20);
frmEmpty.namedFoundSet = JSForm.EMPTY_FOUNDSET;

// form with an initial foundset based on a global relation
var frmGlobalRel = solutionModel.newForm("categories_related", solutionModel.getForm("categories"));
frmGlobalRel.namedFoundSet = "g2_to_category_name";

// form with an initial foundset based on a global relation
var frmGlobalRel = solutionModel.newForm("categories_related", solutionModel.getForm("categories"));
frmGlobalRel.namedFoundSet = solutionModel.getRelation("g1_to_categories");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	navigator

Table Row (tr)

id	name

Table Cell (td)
navigator

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The navigator (previously named "controller")
that is used to control/navigate to the form. The navigator is shown at
the left or at the right side of the form, depending on the page orientation.

The following options are available:
-none- - no navigator is assigned.
DEFAULT - the Servoy default navigator is assigned.
IGNORE - the navigator last assigned to a previous form.
Custom - a custom navigator based on a selected form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var aForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
// you can also use SM_DEFAULTS.INGORE to just reuse the navigator that is already set, or SM_DEFAULTS.DEFAULT to have the default servoy navigator.
// here we assign an other new form as the navigator.
var aNavigator = solutionModel.newForm('navForm', myDatasource, null, false, 800, 600);
// set the navigators navigator to NONE
aNavigator.navigator = SM_DEFAULTS.NONE; // Hide the navigator on the form.
myListViewForm.navigator = aNavigator;
application.output(myListViewForm.navigator.name);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDeleteAllRecordsCmd

Table Row (tr)

id	name

Table Cell (td)
onDeleteAllRecordsCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Delete All.
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onNewRecordCmd = form.newMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }');
form.onDuplicateRecordCmd = form.newMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteRecordCmd = form.newMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteAllRecordsCmd = form.newMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDeleteRecordCmd

Table Row (tr)

id	name

Table Cell (td)
onDeleteRecordCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Delete Record (or keyboard shortcut).
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onNewRecordCmd = form.newMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }');
form.onDuplicateRecordCmd = form.newMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteRecordCmd = form.newMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteAllRecordsCmd = form.newMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDrag

Table Row (tr)

id	name

Table Cell (td)
onDrag

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dragging occurs.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDragEnd

Table Row (tr)

id	name

Table Cell (td)
onDragEnd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dragging end occurs.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDragOver

Table Row (tr)

id	name

Table Cell (td)
onDragOver

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dragging over a component occurs.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDrop

Table Row (tr)

id	name

Table Cell (td)
onDrop

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when (non Design Mode) dropping occurs.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onDrag = form.newMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDuplicateRecordCmd

Table Row (tr)

id	name

Table Cell (td)
onDuplicateRecordCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Duplicate Record (or keyboard shortcut).
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onNewRecordCmd = form.newMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }');
form.onDuplicateRecordCmd = form.newMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteRecordCmd = form.newMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteAllRecordsCmd = form.newMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onElementFocusGained

Table Row (tr)

id	name

Table Cell (td)
onElementFocusGained

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when focus is gained by a component inside the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onElementFocusGained = form.newMethod('function onElementFocusGained(event) { application.output("onElementFocusGained intercepted from " + event.getSource()); }');
form.onElementFocusLost = form.newMethod('function onElementFocusLost(event) { application.output("onElementFocusLost intercepted from " + event.getSource()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onElementFocusLost

Table Row (tr)

id	name

Table Cell (td)
onElementFocusLost

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that gets triggered when focus is lost by a component inside the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onElementFocusGained = form.newMethod('function onElementFocusGained(event) { application.output("onElementFocusGained intercepted from " + event.getSource()); }');
form.onElementFocusLost = form.newMethod('function onElementFocusLost(event) { application.output("onElementFocusLost intercepted from " + event.getSource()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onFindCmd

Table Row (tr)

id	name

Table Cell (td)
onFindCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Find (or keyboard shortcut) in Data (ready) mode.
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onFindCmd = form.newMethod('function onFindCmd(event) { application.output("onFindCmd intercepted on " + event.getFormName()); }');
form.onSearchCmd = form.newMethod('function onSearchCmd(event) { application.output("onSearchCmd intercepted on " + event.getFormName()); }');
form.onShowAllRecordsCmd = form.newMethod('function onShowAllRecordsCmd(event) { application.output("onShowAllRecordsCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onHide

Table Row (tr)

id	name

Table Cell (td)
onHide

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onInvertRecordsCmd

Table Row (tr)

id	name

Table Cell (td)
onInvertRecordsCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Invert Records.
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onOmitRecordCmd = form.newMethod('function onOmitRecordCmd(event) { application.output("onOmitRecordCmd intercepted on " + event.getFormName()); }');
form.onShowOmittedRecordsCmd = form.newMethod('function onShowOmittedRecordsCmd(event) { application.output("onShowOmittedRecordsCmd intercepted on " + event.getFormName()); }');
form.onInvertRecordsCmd = form.newMethod('function onInvertRecordsCmd(event) { application.output("onInvertRecordsCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onLoad

Table Row (tr)

id	name

Table Cell (td)
onLoad

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onNewRecordCmd

Table Row (tr)

id	name

Table Cell (td)
onNewRecordCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > New Record (or keyboard shortcut).
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onNewRecordCmd = form.newMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }');
form.onDuplicateRecordCmd = form.newMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteRecordCmd = form.newMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteAllRecordsCmd = form.newMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onNextRecordCmd

Table Row (tr)

id	name

Table Cell (td)
onNextRecordCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Next Record.
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onPreviousRecordCmd = form.newMethod('function onPreviousRecordCmd(event) { application.output("onPreviousRecordCmd intercepted on " + event.getFormName()); }');
form.onNextRecordCmd = form.newMethod('function onNextRecordCmd(event) { application.output("onNextRecordCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onOmitRecordCmd

Table Row (tr)

id	name

Table Cell (td)
onOmitRecordCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Omit Record.
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onOmitRecordCmd = form.newMethod('function onOmitRecordCmd(event) { application.output("onOmitRecordCmd intercepted on " + event.getFormName()); }');
form.onShowOmittedRecordsCmd = form.newMethod('function onShowOmittedRecordsCmd(event) { application.output("onShowOmittedRecordsCmd intercepted on " + event.getFormName()); }');
form.onInvertRecordsCmd = form.newMethod('function onInvertRecordsCmd(event) { application.output("onInvertRecordsCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onPreviousRecordCmd

Table Row (tr)

id	name

Table Cell (td)
onPreviousRecordCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Previous Record.
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onPreviousRecordCmd = form.newMethod('function onPreviousRecordCmd(event) { application.output("onPreviousRecordCmd intercepted on " + event.getFormName()); }');
form.onNextRecordCmd = form.newMethod('function onNextRecordCmd(event) { application.output("onNextRecordCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onPrintPreviewCmd

Table Row (tr)

id	name

Table Cell (td)
onPrintPreviewCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item File > Print Preview.
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onPrintPreviewCmd = form.newMethod('function onPrintPreviewCmd(event) { application.output("onPrintPreviewCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRecordEditStart

Table Row (tr)

id	name

Table Cell (td)
onRecordEditStart

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when a user clicks into a column on the form.
NOTE: There is a small "e" displayed in the lower left side of the Servoy Client screen in the status area at the bottom of the window when the record is being edited.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRecordEditStop

Table Row (tr)

id	name

Table Cell (td)
onRecordEditStop

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when a record is being saved.
A record is saved when a user clicks out of it (for example on an empty part of the layout or to another form).
When the method returns false (for example as part of a validation), the user cannot leave the record, for example in
a table view a user cannot move to another record when the callback returns false.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRecordSelection

Table Row (tr)

id	name

Table Cell (td)
onRecordSelection

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRender

Table Row (tr)

id	name

Table Cell (td)
onRender

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is rendered.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onRender = form.newMethod('function onRender(event) { event.getElement().bgcolor = \'#00ff00\' }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onResize

Table Row (tr)

id	name

Table Cell (td)
onResize

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that gets triggered when resize occurs.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onResize = form.newMethod('function onResize(event) { application.output("onResize intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onSearchCmd

Table Row (tr)

id	name

Table Cell (td)
onSearchCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Search (or keyboard shortcut) in Find mode.
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onFindCmd = form.newMethod('function onFindCmd(event) { application.output("onFindCmd intercepted on " + event.getFormName()); }');
form.onSearchCmd = form.newMethod('function onSearchCmd(event) { application.output("onSearchCmd intercepted on " + event.getFormName()); }');
form.onShowAllRecordsCmd = form.newMethod('function onShowAllRecordsCmd(event) { application.output("onShowAllRecordsCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onShow

Table Row (tr)

id	name

Table Cell (td)
onShow

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onShowAllRecordsCmd

Table Row (tr)

id	name

Table Cell (td)
onShowAllRecordsCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Show All (or keyboard shortcut).
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onFindCmd = form.newMethod('function onFindCmd(event) { application.output("onFindCmd intercepted on " + event.getFormName()); }');
form.onSearchCmd = form.newMethod('function onSearchCmd(event) { application.output("onSearchCmd intercepted on " + event.getFormName()); }');
form.onShowAllRecordsCmd = form.newMethod('function onShowAllRecordsCmd(event) { application.output("onShowAllRecordsCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onShowOmittedRecordsCmd

Table Row (tr)

id	name

Table Cell (td)
onShowOmittedRecordsCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Show Omitted Records.
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onOmitRecordCmd = form.newMethod('function onOmitRecordCmd(event) { application.output("onOmitRecordCmd intercepted on " + event.getFormName()); }');
form.onShowOmittedRecordsCmd = form.newMethod('function onShowOmittedRecordsCmd(event) { application.output("onShowOmittedRecordsCmd intercepted on " + event.getFormName()); }');
form.onInvertRecordsCmd = form.newMethod('function onInvertRecordsCmd(event) { application.output("onInvertRecordsCmd intercepted on " + event.getFormName()); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onSortCmd

Table Row (tr)

id	name

Table Cell (td)
onSortCmd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that overrides the Servoy menu item Select > Sort.
This property is automatically set to "DEFAULT" (no override) when the form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.onSortCmd = form.newMethod('function onSortCmd(dataProviderID, asc, event) { application.output("onSortCmd intercepted on " + event.getFormName() + ". data provider: " + dataProviderID + ". asc: " + asc); }');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onUnLoad

Table Row (tr)

id	name

Table Cell (td)
onUnLoad

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when a form is unloaded from the repository.
NOTE: Forms can be prevented from being removed from memory by referencing the form object in a global variable or inside an array inside a global variable. Do take care using this technique.
Forms take up memory and if too many forms are in memory and cannot be unloaded, there is a possibility of running out of memory.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	paperPrintScale

Table Row (tr)

id	name

Table Cell (td)
paperPrintScale

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The percentage value the printed page is enlarged or reduced to; the size of the printed form
is inversely proportional. For example, if the paperPrintScale is 50, the printed form will be
enlarged 200%.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('myForm',myDatasource,null,true,800,600);
if (form.paperPrintScale < 100)
	form.paperPrintScale = 100;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	scrollbars

Table Row (tr)

id	name

Table Cell (td)
scrollbars

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Scrollbar options for the vertical and horizontal scrollbars. Each of the
vertical and horizontal scrollbars can be configured to display all the time,
to display only when needed or to never display.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('myForm',myDatasource,null,true,1000,600);
form.scrollbars = SM_SCROLLBAR.VERTICAL_SCROLLBAR_NEVER;
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	selectionMode

Table Row (tr)

id	name

Table Cell (td)
selectionMode

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the value of the form's selectionMode property.
Selection mode is applied when necessary to the foundset used by the form (through it's multiSelect property), even if the foundset changes.
If two or more forms with non-default and different selectionMode values share the same foundset, the visible one decides.
If two or more non-visible forms with non-default and different selectionMode values share the same foundset, one of them (always the same from a set of forms) decides.
If two or more visible forms with non-default and different selectionMode values share the same foundset, one of them (always the same from a set of forms) decides what the
foundset's selectionMode should be.

Can be one of SELECTION_MODE_DEFAULT, SELECTION_MODE_SINGLE or SELECTION_MODE_MULTI.

Table Row (tr)

id	snc

Table Cell (td)

Since

Div

class	sIndent

6.1

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myForm = solutionModel.getForm('my_form_name');
if (myForm.selectionMode == JSForm.SELECTION_MODE_MULTI) myForm.selectionMode = JSForm.SELECTION_MODE_DEFAULT;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	serverName

Table Row (tr)

id	name

Table Cell (td)
serverName

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the server name used by this form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('myForm',myDatasource,null,true,800,600);
form.serverName = 'anotherServerName';
var theServerName = form.serverName;
application.output(theServerName);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showInMenu

Table Row (tr)

id	name

Table Cell (td)
showInMenu

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set, the form is displayed under the Window menu.
If it is not set, the form will be 'hidden'.
NOTE: This is only applicable for Servoy Client. Servoy Developer always shows all forms so that
developers have access to all forms within a solution during development.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var aForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var anotherForm= solutionModel.newForm('newForm2', myDatasource, null, true, 800, 600);
//using 'anotherForm' as navigator for aForm
anotherForm.showInMenu = false;
anotherForm.navigator = null;
aForm.navigator = anotherForm;
application.output(aForm.navigator.name);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	styleClass

Table Row (tr)

id	name

Table Cell (td)
styleClass

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The Cascading Style Sheet (CSS) class name applied to the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var aForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
if (aForm.styleClass == null)
	aForm.styleClass = someStyleClass;
else
	application.output("The Cascading Style Sheet (CSS) class name applied to this form is " + aForm.styleClass);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	styleName

Table Row (tr)

id	name

Table Cell (td)
styleName

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the Servoy style that is being used on the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var aForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
if (aForm.styleName == null)
	aForm.styleName = someServoyStyleName;
else
	application.output("The name of the Servoy style that is being used on the form is " + aForm.styleName);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	tableName

Table Row (tr)

id	name

Table Cell (td)
tableName

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The [name of the table/SQL view].[the name of the database server connection] the form is based on.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	titleText

Table Row (tr)

id	name

Table Cell (td)
titleText

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The text that displays in the title bar of the form window.
NOTE: Data tags and Servoy tags can be used as part of the title text.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myForm = solutionModel.newForm('newForm', 'db:/a_server/a_table', 'aStyleName', false, 800, 600)
forms['newForm'].controller.show();
if (myForm.titleText == null)
{
	myForm.titleText = "My new title text should be really cool!"
	forms['newForm'].controller.recreateUI();
}
else
	application.output("My text text is already cool");

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	transparent

Table Row (tr)

id	name

Table Cell (td)
transparent

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set, the form is transparent.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('myForm',myDatasource,null,true,1000,800);
if (form.transparent == false)
{
	var style = solutionModel.newStyle('myStyle','form { background-color: yellow; }');
	style.text = style.text + 'field { background-color: blue; }';
	form.styleName = 'myStyle';
}
var field = form.newField('columnTextDataProvider',JSField.TEXT_FIELD,100,100,100,50);
forms['myForm'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	view

Table Row (tr)

id	name

Table Cell (td)
view

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The default form view mode.

The view can be changed using a method at runtime. The following views are available:
- Record view
- List view
- Record view (locked)
- List view (locked)
- Table View (locked)

NOTE: Only Table View (locked) uses asynchronized related data loading.
This feature defers all related foundset data loading to the background - enhancing
the visual display of a related foundset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
myForm.view = JSForm.RECORD_VIEW;
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	width

Table Row (tr)

id	name

Table Cell (td)
width

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The width of the form in pixels.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myForm = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
forms['newForm1'].controller.show();
myForm.width = 120;
forms['newForm1'].controller.recreateUI();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	getBean-String

Table Row (tr)

id	name

Table Cell (td)
getBean

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSBean

Span

style	font-weight: bold;

getBean

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a JSBean that has the given name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the bean

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSBean - a JSBean object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var btn = myForm.getBean("mybean");
application.output(mybean.className);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getBeans

Table Row (tr)

id	name

Table Cell (td)
getBeans

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSBean[]

Span

style	font-weight: bold;

getBeans

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSBeans of this form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSBean[] - the list of all JSbuttons on this forms

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var beans = myForm.getBeans();
for (var b in beans)
{
	if (beans[b].name != null)
		application.output(beans[b].name);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getBeans-Boolean

Table Row (tr)

id	name

Table Cell (td)
getBeans

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSBean[]

Span

style	font-weight: bold;

getBeans

Span
(returnInheritedElements)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSBeans of this form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} returnInheritedElements - true to also return the elements from parent form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSBean[] - the list of all JSbuttons on this forms

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var beans = myForm.getBeans();
for (var b in beans)
{
	if (beans[b].name != null)
		application.output(beans[b].name);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getBodyPart

Table Row (tr)

id	name

Table Cell (td)
getBodyPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

getBodyPart

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves the Body part of the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the Body part of the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.getBodyPart().background = 'blue';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getButton-String

Table Row (tr)

id	name

Table Cell (td)
getButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSButton

Span

style	font-weight: bold;

getButton

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a JSButton that has the given name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the button

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSButton - a JSButton object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var btn = myForm.getButton("hello");
application.output(btn.text);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getButtons

Table Row (tr)

id	name

Table Cell (td)
getButtons

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSButton[]

Span

style	font-weight: bold;

getButtons

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSButtons of this form, including the ones without a name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSButton[] - the list of all JSbuttons on this forms

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getButtons-Boolean

Table Row (tr)

id	name

Table Cell (td)
getButtons

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSButton[]

Span

style	font-weight: bold;

getButtons

Span
(returnInheritedElements)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSButtons of this form, including the ones without a name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} returnInheritedElements - true to also return the elements from parent form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSButton[] - the list of all JSbuttons on this forms

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getComponent-String

Table Row (tr)

id	name

Table Cell (td)
getComponent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSComponent

Span

style	font-weight: bold;

getComponent

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a JSComponent that has the given name; if found it will be a JSField, JSLabel, JSButton, JSPortal, JSBean or JSTabPanel.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the component

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSComponent - a JSComponent object (might be a JSField, JSLabel, JSButton, JSPortal, JSBean or JSTabPanel)

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var cmp = frm.getComponent("componentName");
application.output("Component type and name: " + cmp);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getComponents

Table Row (tr)

id	name

Table Cell (td)
getComponents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSComponent[]

Span

style	font-weight: bold;

getComponents

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSComponent[] - an array of all the JSComponents on the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getComponents-Boolean

Table Row (tr)

id	name

Table Cell (td)
getComponents

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSComponent[]

Span

style	font-weight: bold;

getComponents

Span
(returnInheritedElements)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} returnInheritedElements - true to also return the elements from the parent form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSComponent[] - an array of all the JSComponents on the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDesignTimeProperty

Table Row (tr)

id	name

Table Cell (td)
getDesignTimeProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

getDesignTimeProperty

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get a design-time property of a form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm('orders')
var prop = frm.getDesignTimeProperty('myprop')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDesignTimePropertyNames

Table Row (tr)

id	name

Table Cell (td)
getDesignTimePropertyNames

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getDesignTimePropertyNames

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the design-time properties of a form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm('orders')
var propNames = frm.getDesignTimePropertyNames()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getField-String

Table Row (tr)

id	name

Table Cell (td)
getField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

getField

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The field with the specified name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the field

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a JSField object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.getForm("myForm");
var field = form.getField("myField");
application.output(field.dataProviderID);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFields

Table Row (tr)

id	name

Table Cell (td)
getFields

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField[]

Span

style	font-weight: bold;

getFields

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSField objects of this form, including the ones without a name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField[] - all JSField objects of this form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFields-Boolean

Table Row (tr)

id	name

Table Cell (td)
getFields

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField[]

Span

style	font-weight: bold;

getFields

Span
(returnInheritedElements)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSField objects of this form, including the ones without a name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} returnInheritedElements - true to also return the elements from the parent form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField[] - all JSField objects of this form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getFooterPart

Table Row (tr)

id	name

Table Cell (td)
getFooterPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

getFooterPart

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves the Footer part of the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the Footer part of the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.getFooterPart().background = 'magenta';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getHeaderPart

Table Row (tr)

id	name

Table Cell (td)
getHeaderPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

getHeaderPart

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves the Header part of the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the Header part of the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.getHeaderPart().background = 'orange';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLabel-String

Table Row (tr)

id	name

Table Cell (td)
getLabel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSLabel

Span

style	font-weight: bold;

getLabel

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a JSLabel that has the given name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the label

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSLabel - a JSLabel object (or null if the label with the specified name does not exist)

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var label = frm.getLabel("myLabel");
application.output(label.text);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLabels

Table Row (tr)

id	name

Table Cell (td)
getLabels

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSLabel[]

Span

style	font-weight: bold;

getLabels

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSLabels of this form (not including its super form), including the ones without a name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSLabel[] - all JSLabels on this form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLabels-Boolean

Table Row (tr)

id	name

Table Cell (td)
getLabels

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSLabel[]

Span

style	font-weight: bold;

getLabels

Span
(returnInheritedElements)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSLabels of this form (optionally including it super forms labels), including the ones without a name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} returnInheritedElements - true to also return the elements from parent form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSLabel[] - all JSLabels on this form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLeadingGrandSummaryPart

Table Row (tr)

id	name

Table Cell (td)
getLeadingGrandSummaryPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

getLeadingGrandSummaryPart

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves the Leading Grand Summary part of the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the Leading Grand Summary part of the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.getLeadingGrandSummaryPart().background = 'yellow';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLeadingSubSummaryParts

Table Row (tr)

id	name

Table Cell (td)
getLeadingSubSummaryParts

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart[]

Span

style	font-weight: bold;

getLeadingSubSummaryParts

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of the Leading Subsummary parts of the form, ordered by their height from top == 0 to bottom.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart[] - An array of JSPart instances corresponding to the Leading Subsummary parts of the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.getLeadingSubSummaryParts()[0].background = 'green';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMethod-String

Table Row (tr)

id	name

Table Cell (td)
getMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSMethod

Span

style	font-weight: bold;

getMethod

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an existing form method for the given name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the method

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod - a JSMethod object (or null if the method with the specified name does not exist)

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var method = frm.getMethod("myMethod");
application.output(method.code);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMethods

Table Row (tr)

id	name

Table Cell (td)
getMethods

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSMethod[]

Span

style	font-weight: bold;

getMethods

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all existing form methods for this form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod[] - all form methods for the form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var methods = frm.getMethods();
for (var m in methods)
	application.output(methods[m].getName());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMethods-Boolean

Table Row (tr)

id	name

Table Cell (td)
getMethods

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSMethod[]

Span

style	font-weight: bold;

getMethods

Span
(returnInheritedElements)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all existing form methods for this form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} returnInheritedElements - true to also return the elements from the parent form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod[] - all form methods for the form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var methods = frm.getMethods();
for (var m in methods)
	application.output(methods[m].getName());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPart-Number

Table Row (tr)

id	name

Table Cell (td)
getPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

getPart

Span
(type)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets a part of the form from the given type (see JSPart constants).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} type - The type of the part to retrieve.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance representing the retrieved form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.getPart(JSPart.HEADER).background = 'red';
form.getPart(JSPart.LEADING_SUBSUMMARY, 160).background = 'red';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPart-Number_Number

Table Row (tr)

id	name

Table Cell (td)
getPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

getPart

Span
(type, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets a part of the form from the given type (see JSPart constants).
Use the height if you want to get a specific LEADING_SUBSUMMARY or TRAILING_SUBSUMMARY.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} type - The type of the part to retrieve.
{Number} height - The height of the part to retrieve. Use this parameter when retrieving one of multiple
Leading/Trailing Subsummary parts.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance representing the retrieved form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.getPart(JSPart.HEADER).background = 'red';
form.getPart(JSPart.LEADING_SUBSUMMARY, 160).background = 'red';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPartYOffset-Number

Table Row (tr)

id	name

Table Cell (td)
getPartYOffset

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getPartYOffset

Span
(type)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the Y offset of a given part (see JSPart) of the form. This will include
all the super forms parts if this form extends a form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} type - The type of the part whose Y offset will be returned.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - A number holding the Y offset of the specified form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// get the subform
var form = solutionModel.getForm('SubForm');
// get the start offset of the body
var height = form.getPartYOffset(JSPart.BODY);
// place a new button based on the start offset.
form.newButton('mybutton',50,50+height,80,20,solutionModel.getGlobalMethod('globals', 'test'));

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPartYOffset-Number_Number

Table Row (tr)

id	name

Table Cell (td)
getPartYOffset

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getPartYOffset

Span
(type, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the Y offset of a given part (see JSPart) of the form. This will include
all the super forms parts if this form extends a form. Use the height parameter for
targetting one of multiple subsummary parts.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} type - The type of the part whose Y offset will be returned.
{Number} height - The height of the part whose Y offset will be returned. This is used when
one of multiple Leading/Trailing Sumsummary parts is retrieved.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - A number holding the Y offset of the specified form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// get the subform
var form = solutionModel.getForm('SubForm');
// get the start offset of the body
var height = form.getPartYOffset(JSPart.BODY);
// place a new button based on the start offset.
form.newButton('mybutton',50,50+height,80,20,solutionModel.getGlobalMethod('globals', 'test'));

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getParts

Table Row (tr)

id	name

Table Cell (td)
getParts

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart[]

Span

style	font-weight: bold;

getParts

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets all the parts from the form (not including the parts of the parent form), ordered by there height (lowerbound) property, from top == 0 to bottom.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart[] - An array of JSPart instances corresponding to the parts of the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var allParts = form.getParts()
for (var i=0; i<allParts.length; i++) {
	if (allParts[i].getPartType() == JSPart.BODY)
		application.output('body Y offset: ' + allParts[i].getPartYOffset());
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getParts-Boolean

Table Row (tr)

id	name

Table Cell (td)
getParts

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart[]

Span

style	font-weight: bold;

getParts

Span
(returnInheritedElements)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets all the parts from the form (optionally also from the parent form), ordered by there height (lowerbound) property, from top == 0 to bottom.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} returnInheritedElements - true to also return the parts from parent form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart[] - An array of JSPart instances corresponding to the parts of the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var allParts = form.getParts()
for (var i=0; i<allParts.length; i++) {
	if (allParts[i].getPartType() == JSPart.BODY)
		application.output('body Y offset: ' + allParts[i].getPartYOffset());
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPortal-String

Table Row (tr)

id	name

Table Cell (td)
getPortal

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPortal

Span

style	font-weight: bold;

getPortal

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a JSPortal that has the given name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the portal

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPortal - a JSPortal object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var portal = frm.getPortal("myPortal");
portal.initialSort = 'my_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPortals

Table Row (tr)

id	name

Table Cell (td)
getPortals

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPortal[]

Span

style	font-weight: bold;

getPortals

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSPortal objects of this form (not including the ones from the parent form), including the ones without a name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPortal[] - an array of all JSPortal objects on this form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var portals = frm.getPortals();
for (var i in portals)
{
	var p = portals[i];
	if (p.name != null)
		application.output(p.name);
	else
		application.output("unnamed portal detected");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getPortals-Boolean

Table Row (tr)

id	name

Table Cell (td)
getPortals

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPortal[]

Span

style	font-weight: bold;

getPortals

Span
(returnInheritedElements)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSPortal objects of this form (optionally also the ones from the parent form), including the ones without a name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} returnInheritedElements - true to also return the elements from parent form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPortal[] - an array of all JSPortal objects on this form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var portals = frm.getPortals();
for (var i in portals)
{
	var p = portals[i];
	if (p.name != null)
		application.output(p.name);
	else
		application.output("unnamed portal detected");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTabPanel-String

Table Row (tr)

id	name

Table Cell (td)
getTabPanel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSTabPanel

Span

style	font-weight: bold;

getTabPanel

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns a JSTabPanel that has the given name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the tabpanel

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSTabPanel - a JSTabPanel object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var tabPanel = frm.getTabPanel("myTabPanel");
var tabs = tabPanel.getTabs();
for (var i=0; i<tabs.length; i++)
	application.output("Tab " + i + " has text " + tabs[i].text);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTabPanels

Table Row (tr)

id	name

Table Cell (td)
getTabPanels

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSTabPanel[]

Span

style	font-weight: bold;

getTabPanels

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSTabPanels of this form (not including the ones from the parent form), including the ones without a name.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSTabPanel[] - an array of all JSTabPanel objects on this form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var tabPanels = frm.getTabPanels();
for (var i in tabPanels)
{
	var tp = tabPanels[i];
	if (tp.name != null)
		application.output("Tab " + tp.name + " has text " + tp.text);
	else
		application.output("Tab with text " + tp.text + " has no name");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTabPanels-Boolean

Table Row (tr)

id	name

Table Cell (td)
getTabPanels

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSTabPanel[]

Span

style	font-weight: bold;

getTabPanels

Span
(returnInheritedElements)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns all JSTabPanels of this form (optionally the ones from the parent form), including the ones without a name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} returnInheritedElements - true to also return the elements from parent form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSTabPanel[] - an array of all JSTabPanel objects on this form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var tabPanels = frm.getTabPanels();
for (var i in tabPanels)
{
	var tp = tabPanels[i];
	if (tp.name != null)
		application.output("Tab " + tp.name + " has text " + tp.text);
	else
		application.output("Tab with text " + tp.text + " has no name");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTitleFooterPart

Table Row (tr)

id	name

Table Cell (td)
getTitleFooterPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

getTitleFooterPart

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves the Title Footer part of the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the Title Footer part of the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.getTitleFooterPart().background = 'gray';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTitleHeaderPart

Table Row (tr)

id	name

Table Cell (td)
getTitleHeaderPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

getTitleHeaderPart

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves the Title Header part of the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the Title Header part of the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.getTitleHeaderPart().background = 'red';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTrailingGrandSummaryPart

Table Row (tr)

id	name

Table Cell (td)
getTrailingGrandSummaryPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

getTrailingGrandSummaryPart

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves the Trailing Grand Summary part of the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the Trailing Grand Summary part of the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.getTrailingGrandSummaryPart().background = 'yellow';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTrailingSubSummaryParts

Table Row (tr)

id	name

Table Cell (td)
getTrailingSubSummaryParts

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart[]

Span

style	font-weight: bold;

getTrailingSubSummaryParts

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an array of the Trailing Subsummary parts of the form, ordered by their height from top == 0 to bottom.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart[] - An array of JSPart instances corresponding to the Trailing Subsummary parts of the form.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.getTrailingSubSummaryParts()[0].background = 'green';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getUUID

Table Row (tr)

id	name

Table Cell (td)
getUUID

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

UUID

Span

style	font-weight: bold;

getUUID

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the UUID of this form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

UUID

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form_UUID = myForm.getUUID();
application.output(form_UUID.toString());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getVariable-String

Table Row (tr)

id	name

Table Cell (td)
getVariable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSVariable

Span

style	font-weight: bold;

getVariable

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets an existing form variable for the given name.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the variable

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSVariable - a JSVariable object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
	var fvariable = frm.getVariable("myVarName");
	application.output(fvariable.name + " has the default value of " + fvariable.defaultValue);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getVariables

Table Row (tr)

id	name

Table Cell (td)
getVariables

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSVariable[]

Span

style	font-weight: bold;

getVariables

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

An array consisting of all form variables for this form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSVariable[] - an array of all variables on this form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var variables = frm.getVariables();
for (var i in variables)
	application.output(variables[i].name);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getVariables-Boolean

Table Row (tr)

id	name

Table Cell (td)
getVariables

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSVariable[]

Span

style	font-weight: bold;

getVariables

Span
(returnInheritedElements)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

An array consisting of all form variables for this form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} returnInheritedElements - true to also return the elements from the parent form

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSVariable[] - an array of all variables on this form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm("myForm");
var variables = frm.getVariables();
for (var i in variables)
	application.output(variables[i].name);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newBean-String_String_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newBean

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSBean

Span

style	font-weight: bold;

newBean

Span
(name, className, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSBean object on the form - including the name of the JSBean object; the classname the JSBean object is based on, the "x" and "y" position of the JSBean object in pixels, as well as the width and height of the JSBean object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the JSBean object
{String} className - the class name of the JSBean object
{Number} x - the horizontal "x" position of the JSBean object in pixels
{Number} y - the vertical "y" position of the JSBean object in pixels
{Number} width - the width of the JSBean object in pixels
{Number} height - the height of the JSBean object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSBean - a JSBean object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', 'db:/server1/table1', null, true, 800, 600);
var bean = form.newBean('bean','com.servoy.extensions.beans.dbtreeview.DBTreeView',200,200,300,300);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newButton-String_Number_Number_Number_Number_Object

Table Row (tr)

id	name

Table Cell (td)
newButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSButton

Span

style	font-weight: bold;

newButton

Span
(txt, x, y, width, height, action)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new button on the form with the given text, place, size and JSMethod as the onAction event triggered action.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} txt - the text on the button
{Number} x - the x coordinate of the button location on the form
{Number} y - the y coordinate of the button location on the form
{Number} width - the width of the button
{Number} height - the height of the button
{Object} action - the method assigned to handle an onAction event

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSButton - a new JSButton object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var method = form.newMethod('function onAction(event) { application.output("onAction intercepted on " + event.getFormName()); }');
var button = form.newButton('myButton', 10, 10, 100, 30, method);
application.output("The new button: " + button.name + " has the following onAction event handling method assigned " + button.onAction.getName());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newCalendar-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newCalendar

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newCalendar

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of CALENDAR - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a new JSField object on the form with the displayType of CALENDAR

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var calendar = form.newCalendar(myDataProvider, 100, 100, 200, 200);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newCheck-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newCheck

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newCheck

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of CHECK (checkbox) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a new JSField object on the form with the displayType of CHECK (checkbox)

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var calendar = form.newCheck(myDataProvider, 100, 100, 200, 200);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newComboBox-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newComboBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newComboBox

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of COMBOBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a new JSField object on the form with the displayType of COMBOBOX

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var calendar = form.newComboBox(myDataProvider, 100, 100, 200, 200);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newField-Object_Number_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newField

Span
(dataprovider, type, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} 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} x - the horizontal "x" position of the JSField object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a new JSField object (of the specified display type)

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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, 100, 100, 200, 200);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newFooterPart-Number

Table Row (tr)

id	name

Table Cell (td)
newFooterPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

newFooterPart

Span
(height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new Footer part on the form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} height - The height of the new part

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSFooter instance corresponding to the newly created Footer form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var footer = form.newFooterPart(440);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newHeaderPart-Number

Table Row (tr)

id	name

Table Cell (td)
newHeaderPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

newHeaderPart

Span
(height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new Header part on the form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} height - The height of the new part

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the newly created Header form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var header = form.newHeaderPart(80);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newHtmlArea-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newHtmlArea

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newHtmlArea

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of HTML_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a JSField object on the form with the displayType of HTML_AREA

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var textProvider = form.newVariable('myVar',JSVariable.TEXT);
textProvider.defaultValue = "'This is a triple quoted text!'";
var htmlArea = myListViewForm.newHtmlArea(textProvider,100,100,100,100);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newImageMedia-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newImageMedia

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newImageMedia

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of IMAGE_MEDIA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a new JSField object on the form with the displayType of IMAGE_MEDIA

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var myMediaVar = form.newVariable("media", JSVariable.MEDIA);
var imageMedia = form.newImageMedia(myMediaVar,100,100,200,200)
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newLabel-String_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newLabel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSLabel

Span

style	font-weight: bold;

newLabel

Span
(txt, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} txt - the specified text of the label object
{Number} x - the horizontal "x" position of the label object in pixels
{Number} y - the vertical "y" position of the label object in pixels
{Number} width - the width of the label object in pixels
{Number} height - the height of the label object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSLabel - a JSLabel object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var label = form.newLabel('The text on the label', 140, 140, 50, 20);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newLabel-String_Number_Number_Number_Number_Object

Table Row (tr)

id	name

Table Cell (td)
newLabel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSLabel

Span

style	font-weight: bold;

newLabel

Span
(txt, x, y, width, height, action)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSLabel object on the form - including the text of the label, the "x" and "y" position of the label object in pixels, the width and height of the label object in pixels and a JSMethod action such as the method for an onAction event.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} txt - the specified text of the label object
{Number} x - the horizontal "x" position of the label object in pixels
{Number} y - the vertical "y" position of the label object in pixels
{Number} width - the width of the label object in pixels
{Number} height - the height of the label object in pixels
{Object} action - the event action JSMethod of the label object

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSLabel - a JSLabel object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var label = form.newLabel('The text on the label', 140, 140, 50, 20);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newLeadingGrandSummaryPart-Number

Table Row (tr)

id	name

Table Cell (td)
newLeadingGrandSummaryPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

newLeadingGrandSummaryPart

Span
(height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new Leading Grand Summary part on the form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} height - The height of the new part

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the newly created Leading Grand Summary form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var leadingGrandSummary = form.newLeadingGrandSummaryPart(120);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newLeadingSubSummaryPart-Number

Table Row (tr)

id	name

Table Cell (td)
newLeadingSubSummaryPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

newLeadingSubSummaryPart

Span
(height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new Leading Subsummary part on the form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} height - The height of the new part

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the newly created Leading Subsummary form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var leadingSubsummary = form.newLeadingSubSummaryPart(160);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newListBox-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newListBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newListBox

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a new JSField object on the form with the displayType of LISTBOX

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
var list = form.newListBox(myDataProvider, 100, 100, 200, 200);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newMethod-String

Table Row (tr)

id	name

Table Cell (td)
newMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSMethod

Span

style	font-weight: bold;

newMethod

Span
(code)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new form JSMethod - based on the specified code.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} code - the specified code for the new method

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod - a new JSMethod object for this form

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newMultiSelectListBox-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newMultiSelectListBox

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newMultiSelectListBox

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of MULTISELECT_LISTBOX - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a new JSField object on the form with the displayType of MULTISELECT_LISTBOX

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
var calendar = form.newMultiSelectListBox(myDataProvider, 100, 100, 200, 200);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newPart-Number_Number

Table Row (tr)

id	name

Table Cell (td)
newPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

newPart

Span
(type, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new part on the form. The type of the new part (use one of the JSPart constants)
and its height must be specified.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} type - The type of the new part.
{Number} height - The height of the new part

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the newly created form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('myForm', 'db:/example_data/my_table', null, false, 1200, 800);
var header = form.newPart(JSPart.HEADER, 100);
header.background = 'yellow';
var body = form.newPart(JSPart.BODY, 700);
body.background = 'green';
var footer = form.newPart(JSPart.FOOTER, 800);
footer.background = 'orange';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newPassword-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newPassword

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newPassword

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of PASSWORD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a new JSField object on the form with the displayType of PASSWORD

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var pass = form.newPassword(scopes.globals.aVariable, 100, 100, 70, 30);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newPortal-String_Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newPortal

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPortal

Span

style	font-weight: bold;

newPortal

Span
(name, relation, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSPortal object on the form - including the name of the JSPortal object; the relation the JSPortal object is based on, the "x" and "y" position of the JSPortal object in pixels, as well as the width and height of the JSPortal object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the JSPortal object
{Object} relation - the relation of the JSPortal object
{Number} x - the horizontal "x" position of the JSPortal object in pixels
{Number} y - the vertical "y" position of the JSPortal object in pixels
{Number} width - the width of the JSPortal object in pixels
{Number} height - the height of the JSPortal object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPortal - a JSPortal object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', 'db:/server1/table1', null, true, 800, 600);
var relation = solutionModel.newRelation('parentToChild','db:/server1/table1','db:/server2/table2',JSRelation.INNER_JOIN);
relation.newRelationItem('another_parent_table_id', '=', 'another_child_table_parent_id');
var portal = form.newPortal('portal',relation,200,200,300,300);
portal.newField('someColumn',JSField.TEXT_FIELD,200,200,120);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newRadios-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newRadios

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newRadios

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of RADIOS (radio buttons) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a JSField object with the displayType of RADIOS (radio buttons)

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', myDatasource, null, true, 800, 600);
var vlist = solutionModel.newValueList('options',JSValueList.CUSTOM_VALUES);
vlist.customValues = "value1\nvalue2\nvalue3";
var radios = form.newRadios('columnDataProvider',100,100,200,200);
radios.valuelist = vlist;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newRtfArea-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newRtfArea

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newRtfArea

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of RTF_AREA (enables more than one line of text to be displayed in a field) - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a JSField object with the displayType of RTF_AREA

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600);
var rtf_area = form.newRtfArea('columnDataProvider',100,100,100,100);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newSpinner-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newSpinner

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newSpinner

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of SPINNER - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a new JSField object on the form with the displayType of SPINNER

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
var spinner = form.newSpinner(myDataProvider, 10, 460, 100, 20);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newTabPanel-String_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newTabPanel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSTabPanel

Span

style	font-weight: bold;

newTabPanel

Span
(name, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSTabPanel object on the form - including the name of the JSTabPanel object, the "x" and "y" position of the JSTabPanel object in pixels, as well as the width and height of the JSTabPanel object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the JSTabPanel object
{Number} x - the horizontal "x" position of the JSTabPanel object in pixels
{Number} y - the vertical "y" position of the JSTabPanel object in pixels
{Number} width - the width of the JSTabPanel object in pixels
{Number} height - the height of the JSTabPanel object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSTabPanel - a JSTabPanel object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('parentForm','db:/server1/parent_table',null,false,640,480);
var childOne = solutionModel.newForm('childOne','db:/server1/child_table',null,false,400,300);
childOne.newField('child_table_text', JSField.TEXT_FIELD,10,10,100,20);
var parentToChild = solutionModel.newRelation('parentToChild','db:/server1/parent_table','db:/server1/child_table',JSRelation.INNER_JOIN);
parentToChild.newRelationItem('parent_table_id','=','child_table_parent_id');
var childTwo = solutionModel.newForm('childTwo','db:/server1/my_table',null,false,400,300);
childTwo.newField('my_table_image', JSField.IMAGE_MEDIA,10,10,100,100);
var tabPanel = form.newTabPanel('tabs',10,10,620,460);
tabPanel.newTab('tab1','Child One',childOne,parentToChild);
tabPanel.newTab('tab2','Child Two',childTwo);
forms['parentForm'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newTextArea-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newTextArea

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newTextArea

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of TEXT_AREA - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSTabPanel object in pixels
{Number} y - the vertical "y" position of the JSTabPanel object in pixels
{Number} width - the width of the JSTabPanel object in pixels
{Number} height - the height of the JSTabPanel object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a JSField object with the displayType of TEXT_AREA

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600);
var globalVar = solutionModel.newGlobalVariable('globals', 'myGlobal',JSVariable.TEXT);
globalVar.defaultValue = "'Type your text in here'";
var textArea = form.newTextArea(globalVar,100,100,300,150);
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newTextField-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newTextField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newTextField

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of TEXT_FIELD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a JSField object with the displayType of TEXT_FIELD

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600);
//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,100,100,200,50);
//or a column data provider as the dataprovider
//textField.dataProviderID = columnTextDataProvider;
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newTitleFooterPart-Number

Table Row (tr)

id	name

Table Cell (td)
newTitleFooterPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

newTitleFooterPart

Span
(height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new Title Footer part on the form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} height - The height of the new part

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the newly created Title Footer form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var titleFooter = form.newTitleFooterPart(500);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newTitleHeaderPart-Number

Table Row (tr)

id	name

Table Cell (td)
newTitleHeaderPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

newTitleHeaderPart

Span
(height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new Title Header part on the form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} height - The height of the new part

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the newly created Title Header form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var titleHeader = form.newTitleHeaderPart(40);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newTrailingGrandSummaryPart-Number

Table Row (tr)

id	name

Table Cell (td)
newTrailingGrandSummaryPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

newTrailingGrandSummaryPart

Span
(height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new Trailing Grand Summary part on the form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} height - The height of the new part

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the newly created Trailing Grand Summary form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var trailingGrandSummary = form.newTrailingGrandSummaryPart(400);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newTrailingSubSummaryPart-Number

Table Row (tr)

id	name

Table Cell (td)
newTrailingSubSummaryPart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSPart

Span

style	font-weight: bold;

newTrailingSubSummaryPart

Span
(height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new Trailing Subsummary part on the form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} height - The height of the new part

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSPart - A JSPart instance corresponding to the newly created Trailing Subsummary form part.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var trailingSubsummary = form.newTrailingSubSummaryPart(360);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newTypeAhead-Object_Number_Number_Number_Number

Table Row (tr)

id	name

Table Cell (td)
newTypeAhead

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSField

Span

style	font-weight: bold;

newTypeAhead

Span
(dataprovider, x, y, width, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Creates a new JSField object on the form with the displayType of TYPE_AHEAD - including the dataprovider/JSVariable of the JSField object, the "x" and "y" position of the JSField object in pixels, as well as the width and height of the JSField object in pixels.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Object} dataprovider - the specified dataprovider name/JSVariable of the JSField object
{Number} x - the horizontal "x" position of the JSfield object in pixels
{Number} y - the vertical "y" position of the JSField object in pixels
{Number} width - the width of the JSField object in pixels
{Number} height - the height of the JSField object in pixels

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSField - a JSField object with the displayType of TYPE_AHEAD

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newForm1',myDatasource,null,true,800,600);
var vlist = solutionModel.newValueList('options',JSValueList.CUSTOM_VALUES);
vlist.customValues = "value1\nvalue2\nvalue3";
var typeAhead = form.newTypeAhead(columnTextDataProvider,100,100,300,200);
typeAhead.valuelist = vlist;
forms['newForm1'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newVariable-String_Number

Table Row (tr)

id	name

Table Cell (td)
newVariable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSVariable

Span

style	font-weight: bold;

newVariable

Span
(name, type)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSVariable - a JSVariable object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newVariable-String_Number_String

Table Row (tr)

id	name

Table Cell (td)
newVariable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSVariable

Span

style	font-weight: bold;

newVariable

Span
(name, type, defaultValue)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSVariable - a JSVariable object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	putDesignTimeProperty

Table Row (tr)

id	name

Table Cell (td)
putDesignTimeProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

putDesignTimeProperty

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set a design-time property of a form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm('orders')
frm.putDesignTimeProperty('myprop', 'lemon')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeBean-String

Table Row (tr)

id	name

Table Cell (td)
removeBean

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeBean

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a JSBean that has the specified name. Returns true if removal was successful, false otherwise.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the JSBean to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if the JSBean has been removed; false otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.getForm('myform');
form.removeBean('mybean')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeButton-String

Table Row (tr)

id	name

Table Cell (td)
removeButton

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeButton

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a JSButton that has the specified name. Returns true if removal was successful, false otherwise.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the JSButton to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if the JSButton has been removed; false otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeComponent-String

Table Row (tr)

id	name

Table Cell (td)
removeComponent

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeComponent

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the component to be deleted

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if component has been successfully deleted; false otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeDesignTimeProperty

Table Row (tr)

id	name

Table Cell (td)
removeDesignTimeProperty

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

removeDesignTimeProperty

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Clear a design-time property of a form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var frm = solutionModel.getForm('orders')
frm.removeDesignTimeProperty('myprop')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeField-String

Table Row (tr)

id	name

Table Cell (td)
removeField

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeField

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a JSField that has the given name. Returns true if removal was successful, false otherwise.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true is the JSField has been successfully removed; false otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeLabel-String

Table Row (tr)

id	name

Table Cell (td)
removeLabel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeLabel

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a JSLabel that has the given name. Returns true if removal successful, false otherwise

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the JSLabel to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if the JSLabel with the given name has successfully been removed; false otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeMethod-String

Table Row (tr)

id	name

Table Cell (td)
removeMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeMethod

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a form JSMethod - based on the specified code.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the method

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if method was removed successfully , false otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removePart-Number

Table Row (tr)

id	name

Table Cell (td)
removePart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removePart

Span
(type)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a JSPart of the given type.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} type - The type of the part that should be removed.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - True if the part is successfully removed, false otherwise.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.removePart(JSPart.HEADER);
form.removePart(JSPart.LEADING_SUBSUMMARY, 160);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removePart-Number_Number

Table Row (tr)

id	name

Table Cell (td)
removePart

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removePart

Span
(type, height)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a JSPart of the given type. The height parameter is for removing one of multiple subsummary parts.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} type - The type of the part that should be removed.
{Number} height - The height of the part that should be removed. This parameter is for
removing one of multiple Leading/Trailing Subsummary parts.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - True if the part is successfully removed, false otherwise.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

form.removePart(JSPart.HEADER);
form.removePart(JSPart.LEADING_SUBSUMMARY, 160);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removePortal-String

Table Row (tr)

id	name

Table Cell (td)
removePortal

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removePortal

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a JSPortal that has the given name. Returns true if removal was successful, false otherwise.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the JSPortal to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if the JSPortal has successfully been removed; false otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newFormX',myDatasource,null,true,800,600);
var relation = solutionModel.newRelation('parentToChild','db:/server1/myTable','db:/server1/myOtherTable',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 jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if (form.removeComponent('jsp') == true) application.output('Portal removed ok'); else application.output('Portal could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var removerButton = form.newButton('Click here to remove the portal',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeTabPanel-String

Table Row (tr)

id	name

Table Cell (td)
removeTabPanel

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeTabPanel

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a JSTabPanel that has the given name. Returns true if removal was successful, false otherwise.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the JSTabPanel to be removed

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true is the JSTabPanel has been successfully removed, false otherwise

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var form = solutionModel.newForm('newFormX','db:/server1/parent_table',null,false,800,600);
var childOne = solutionModel.newForm('childOne','db:/server1/child_table',null,false,400,300);
childOne.newField('child_table_text', JSField.TEXT_FIELD,10,10,100,20);
var parentToChild = solutionModel.newRelation('parentToChild','db:/server1/parent_table','db:/server1/child_table',JSRelation.INNER_JOIN);
parentToChild.newRelationItem('parent_table_id','=','child_table_id');
var childTwo = solutionModel.newForm('childTwo','db:/server1/another_table',null,false,400,300);
childTwo.newField('columnDataProvider', JSField.TEXT_FIELD,10,10,100,100);
var tabPanel = form.newTabPanel('jst',10,10,620,460);
tabPanel.newTab('tab1','Child One',childOne,parentToChild);
tabPanel.newTab('tab2','Child Two',childTwo);
var jsmethod = form.newMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if (form.removeComponent('jst') == true)\n application.output('TabPanel has been removed ok');\n else\n application.output('TabPanel could not be deleted');\n forms['newFormX'].controller.recreateUI();\n}");
var removerButton = form.newButton('Click here to remove the tab panel',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	removeVariable-String

Table Row (tr)

id	name

Table Cell (td)
removeVariable

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

removeVariable

Span
(name)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Removes a form JSVariable - based on the name of the variable object.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} name - the specified name of the variable

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if removed, false otherwise (ex: no var with that name)

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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)

class	lastDetailRow

Table Cell (td)

Child pages

Page History

Versions Compared

Old Version 26

New Version Current

Key

EMPTY_FOUNDSET

LIST_VIEW

LOCKED_LIST_VIEW

LOCKED_RECORD_VIEW

LOCKED_TABLE_VIEW

RECORD_VIEW

SELECTION_MODE_DEFAULT

SELECTION_MODE_MULTI

SELECTION_MODE_SINGLE

SEPARATE_FOUNDSET

borderType

dataSource

defaultPageFormat

encapsulation

extendsForm

initialSort

name

namedFoundSet

navigator

onDeleteAllRecordsCmd

onDeleteRecordCmd

onDrag

onDragEnd

onDragOver

onDrop

onDuplicateRecordCmd

onElementFocusGained

onElementFocusLost

onFindCmd

onHide

onInvertRecordsCmd

onLoad

onNewRecordCmd

onNextRecordCmd

onOmitRecordCmd

onPreviousRecordCmd

onPrintPreviewCmd

onRecordEditStart

onRecordEditStop

onRecordSelection

onRender

onResize

onSearchCmd

onShow

onShowAllRecordsCmd

onShowOmittedRecordsCmd

onSortCmd

onUnLoad

paperPrintScale

scrollbars

selectionMode

serverName

showInMenu

styleClass

styleName

tableName

titleText

transparent

view

width

getBean

getBeans

getBeans

getBodyPart

getButton

getButtons

getButtons

getComponent

getComponents

getComponents

getDesignTimeProperty

getDesignTimePropertyNames

getField

getFields