Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Hidden
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE


HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Constants Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#DEFAULT_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#HIDE_CONTROLLER_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#HIDE_DATAPROVIDERS_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#HIDE_ELEMENTS_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#HIDE_FOUNDSET_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#MODULE_PRIVATE_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#PRIVATE_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#RECORD_VIEW
The constants to set or get the view property of a JSForm.

HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#borderType
The type, color and style of border of the component.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#defaultPageFormat
The default page format for the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#encapsulation
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#initialSort
The default sort order only when the form loads.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#name
The name of the form.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSForm
Table Cell (td)
#navigator
The navigator (previously named "controller")
that is used to control/navigate to the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onDeleteAllRecordsCmd
The method that overrides the Servoy menu item Select > Delete All.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onDrag
The method that is triggered when (non Design Mode) dragging occurs.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onDragEnd
The method that is triggered when (non Design Mode) dragging end occurs.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onDrop
The method that is triggered when (non Design Mode) dropping occurs.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onHide
The method that is triggered when another form is being activated.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onInvertRecordsCmd
The method that overrides the Servoy menu item Select > Invert Records.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onNextRecordCmd
The method that overrides the Servoy menu item Select > Next Record.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onOmitRecordCmd
The method that overrides the Servoy menu item Select > Omit Record.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onPreviousRecordCmd
The method that overrides the Servoy menu item Select > Previous Record.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onPrintPreviewCmd
The method that overrides the Servoy menu item File > Print Preview.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onRecordEditStop
The method that is triggered when a record is being saved.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onRecordSelection
The method that is triggered each time a record is selected.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onRender
The method that is executed when the component is rendered.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onResize
The method that gets triggered when resize occurs.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onShowOmittedRecordsCmd
The method that overrides the Servoy menu item Select > Show Omitted Records.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#onSortCmd
The method that overrides the Servoy menu item Select > Sort.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#scrollbars
Scrollbar options for the vertical and horizontal scrollbars.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#serverName
Get the server name used by this form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#showInMenu
When set, the form is displayed under the Window menu.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#styleClass
The Cascading Style Sheet (CSS) class name applied to the form.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#tableName
The [name of the table/SQL view].
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#titleText
The text that displays in the title bar of the form window.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#transparent
When set, the form is transparent.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#view
The default form view mode.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#width
The width of the form in pixels.

HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSBean
Table Cell (td)
#getBean(name)
Returns a JSBean that has the given name.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSBean[]
Table Cell (td)
#getBeans()
Returns all JSBeans of this form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSBean[]
Table Cell (td)
#getBeans(returnInheritedElements)
Returns all JSBeans of this form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#getBodyPart()
Retrieves the Body part of the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSButton
Table Cell (td)
#getButton(name)
Returns a JSButton that has the given name.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSButton[]
Table Cell (td)
#getButtons()
Returns all JSButtons of this form, including the ones without a name.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#getField(name)
The field with the specified name.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#getFooterPart()
Retrieves the Footer part of the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#getFormMethod(name)
Gets an existing form method for the given name.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod[]
Table Cell (td)
#getFormMethods()
Returns all existing form methods for this form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod[]
Table Cell (td)
#getFormMethods(returnInheritedElements)
Returns all existing form methods for this form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSVariable
Table Cell (td)
#getFormVariable(name)
Gets an existing form variable for the given name.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSVariable[]
Table Cell (td)
#getFormVariables()
An array consisting of all form variables for this form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSVariable[]
Table Cell (td)
#getFormVariables(returnInheritedElements)
An array consisting of all form variables for this form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#getHeaderPart()
Retrieves the Header part of the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSLabel
Table Cell (td)
#getLabel(name)
Returns a JSLabel that has the given name.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#getLeadingGrandSummaryPart()
Retrieves the Leading Grand Summary part of the form.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSPortal
Table Cell (td)
#getPortal(name)
Returns a JSPortal that has the given name.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSTabPanel
Table Cell (td)
#getTabPanel(name)
Returns a JSTabPanel that has the given name.
Table Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#getTitleFooterPart()
Retrieves the Title Footer part of the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#getTitleHeaderPart()
Retrieves the Title Header part of the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#getTrailingGrandSummaryPart()
Retrieves the Trailing Grand Summary part of the form.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
UUID
Table Cell (td)
#getUUID()
Returns the UUID of this form.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSButton
Table Cell (td)
#newButton(text, x, y, width, height, jsmethod)
Creates a new button on the form with the given text, place, size and JSMethod as the onAction event triggered action.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newCalendar(dataprovidername/jsvariable, 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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newCheck(dataprovidername/jsvariable, 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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newComboBox(dataprovidername/jsvariable, 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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newField(dataprovidername/jsvariable, displaytype, 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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#newFooterPart()
Creates a new Footer part on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSMethod
Table Cell (td)
#newFormMethod(code)
Creates a new form JSMethod - based on the specified code.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSVariable
Table Cell (td)
#newFormVariable(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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#newHeaderPart()
Creates a new Header part on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newHtmlArea(dataprovidername/jsvariable, 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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newImageMedia(dataprovidername/jsvariable, 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 Body (tbody)
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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#newLeadingGrandSummaryPart()
Creates a new Leading Grand Summary part on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#newLeadingSubSummaryPart()
Creates a new Leading Subsummary part on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#newPart(type, height)
Creates a new part on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newPassword(dataprovidername/jsvariable, 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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newRadios(dataprovidername/jsvariable, 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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newRtfArea(dataprovidername/jsvariable, 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 Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newTextArea(dataprovidername/jsvariable, 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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newTextField(dataprovidername/jsvariable, 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 Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#newTitleFooterPart()
Creates a new Title Footer part on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#newTitleHeaderPart()
Creates a new Title Header part on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#newTrailingGrandSummaryPart()
Creates a new Trailing Grand Summary part on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSPart
Table Cell (td)
#newTrailingSubSummaryPart()
Creates a new Trailing Subsummary part on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSField
Table Cell (td)
#newTypeAhead(dataprovidername/jsvariable, 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 Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removeBean(name)
Removes a JSBean that has the specified name.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removeButton(name)
Removes a JSButton that has the specified name.
Table Body (tbody)
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 Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removeField(name)
Removes a JSField that has the given name.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removeLabel(name)
Removes a JSLabel that has the given name.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removePart(type)
Removes a JSPart of the given type.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removePart(type, height)
Removes a JSPart of the given type.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removePortal(name)
Removes a JSPortal that has the given name.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#removeTabPanel(name)
Removes a JSTabPanel that has the given name.

HTML Table
idconstant
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Constants Details
Table Body (tbody)
idDEFAULT_ENCAPSULATION
classnode
Table Row (tr)
idname
Table Cell (td)
DEFAULT_ENCAPSULATION
Table Row (tr)
iddes
Table Cell (td)
The constants to set or get the encapsulation property of a JSForm.
They are as follows: JSForm.DEFAULT_ENCAPSULATION, JSForm.PRIVATE_ENCAPSULATION, JSForm.MODULE_PRIVATE_ENCAPSULATION, JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION, JSForm.HIDE_FOUNDSET_ENCAPSULATION, JSForm.HIDE_CONTROLLER_ENCAPSULATION, JSForm.HIDE_ELEMENTS_ENCAPSULATION
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myDefaultForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION;

	var myPrivateForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION;

	var myModulePrivateForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION;

 var myHideDataprovidersForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION;

 var myHideFoundsetForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION;

 var myHideControllerForm = solutionModel.newForm('newForm6', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION;

	var myHideElementsForm = solutionModel.newForm('newForm7', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idHIDE_CONTROLLER_ENCAPSULATION
classnode
Table Row (tr)
idname
Table Cell (td)
HIDE_CONTROLLER_ENCAPSULATION
Table Row (tr)
iddes
Table Cell (td)
The constants to set or get the encapsulation property of a JSForm.
They are as follows: JSForm.DEFAULT_ENCAPSULATION, JSForm.PRIVATE_ENCAPSULATION, JSForm.MODULE_PRIVATE_ENCAPSULATION, JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION, JSForm.HIDE_FOUNDSET_ENCAPSULATION, JSForm.HIDE_CONTROLLER_ENCAPSULATION, JSForm.HIDE_ELEMENTS_ENCAPSULATION
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myDefaultForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION;

	var myPrivateForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION;

	var myModulePrivateForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION;

 var myHideDataprovidersForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION;

 var myHideFoundsetForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION;

 var myHideControllerForm = solutionModel.newForm('newForm6', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION;

	var myHideElementsForm = solutionModel.newForm('newForm7', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idHIDE_DATAPROVIDERS_ENCAPSULATION
classnode
Table Row (tr)
idname
Table Cell (td)
HIDE_DATAPROVIDERS_ENCAPSULATION
Table Row (tr)
iddes
Table Cell (td)
The constants to set or get the encapsulation property of a JSForm.
They are as follows: JSForm.DEFAULT_ENCAPSULATION, JSForm.PRIVATE_ENCAPSULATION, JSForm.MODULE_PRIVATE_ENCAPSULATION, JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION, JSForm.HIDE_FOUNDSET_ENCAPSULATION, JSForm.HIDE_CONTROLLER_ENCAPSULATION, JSForm.HIDE_ELEMENTS_ENCAPSULATION
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myDefaultForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION;

	var myPrivateForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION;

	var myModulePrivateForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION;

 var myHideDataprovidersForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION;

 var myHideFoundsetForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION;

 var myHideControllerForm = solutionModel.newForm('newForm6', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION;

	var myHideElementsForm = solutionModel.newForm('newForm7', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idHIDE_ELEMENTS_ENCAPSULATION
classnode
Table Row (tr)
idname
Table Cell (td)
HIDE_ELEMENTS_ENCAPSULATION
Table Row (tr)
iddes
Table Cell (td)
The constants to set or get the encapsulation property of a JSForm.
They are as follows: JSForm.DEFAULT_ENCAPSULATION, JSForm.PRIVATE_ENCAPSULATION, JSForm.MODULE_PRIVATE_ENCAPSULATION, JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION, JSForm.HIDE_FOUNDSET_ENCAPSULATION, JSForm.HIDE_CONTROLLER_ENCAPSULATION, JSForm.HIDE_ELEMENTS_ENCAPSULATION
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myDefaultForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION;

	var myPrivateForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION;

	var myModulePrivateForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION;

 var myHideDataprovidersForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION;

 var myHideFoundsetForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION;

 var myHideControllerForm = solutionModel.newForm('newForm6', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION;

	var myHideElementsForm = solutionModel.newForm('newForm7', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idHIDE_FOUNDSET_ENCAPSULATION
classnode
Table Row (tr)
idname
Table Cell (td)
HIDE_FOUNDSET_ENCAPSULATION
Table Row (tr)
iddes
Table Cell (td)
The constants to set or get the encapsulation property of a JSForm.
They are as follows: JSForm.DEFAULT_ENCAPSULATION, JSForm.PRIVATE_ENCAPSULATION, JSForm.MODULE_PRIVATE_ENCAPSULATION, JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION, JSForm.HIDE_FOUNDSET_ENCAPSULATION, JSForm.HIDE_CONTROLLER_ENCAPSULATION, JSForm.HIDE_ELEMENTS_ENCAPSULATION
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myDefaultForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION;

	var myPrivateForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION;

	var myModulePrivateForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION;

 var myHideDataprovidersForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION;

 var myHideFoundsetForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION;

 var myHideControllerForm = solutionModel.newForm('newForm6', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION;

	var myHideElementsForm = solutionModel.newForm('newForm7', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idLIST_VIEW
classnode
Table Row (tr)
idname
Table Cell (td)
LIST_VIEW
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myListViewForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myListViewForm.view = JSForm.LIST_VIEW;

	var myLockedListViewForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);	
	myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW;
	
	var myLockedRecordViewForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW;

	var myLockedTableViewForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW;
	
	var myRecordViewForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myRecordViewForm.view = JSForm.RECORD_VIEW;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idLOCKED_LIST_VIEW
classnode
Table Row (tr)
idname
Table Cell (td)
LOCKED_LIST_VIEW
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myListViewForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myListViewForm.view = JSForm.LIST_VIEW;

	var myLockedListViewForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);	
	myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW;
	
	var myLockedRecordViewForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW;

	var myLockedTableViewForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW;
	
	var myRecordViewForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myRecordViewForm.view = JSForm.RECORD_VIEW;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idLOCKED_RECORD_VIEW
classnode
Table Row (tr)
idname
Table Cell (td)
LOCKED_RECORD_VIEW
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myListViewForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myListViewForm.view = JSForm.LIST_VIEW;

	var myLockedListViewForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);	
	myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW;
	
	var myLockedRecordViewForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW;

	var myLockedTableViewForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW;
	
	var myRecordViewForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myRecordViewForm.view = JSForm.RECORD_VIEW;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idLOCKED_TABLE_VIEW
classnode
Table Row (tr)
idname
Table Cell (td)
LOCKED_TABLE_VIEW
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myListViewForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myListViewForm.view = JSForm.LIST_VIEW;

	var myLockedListViewForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);	
	myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW;
	
	var myLockedRecordViewForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW;

	var myLockedTableViewForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW;
	
	var myRecordViewForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myRecordViewForm.view = JSForm.RECORD_VIEW;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idMODULE_PRIVATE_ENCAPSULATION
classnode
Table Row (tr)
idname
Table Cell (td)
MODULE_PRIVATE_ENCAPSULATION
Table Row (tr)
iddes
Table Cell (td)
The constants to set or get the encapsulation property of a JSForm.
They are as follows: JSForm.DEFAULT_ENCAPSULATION, JSForm.PRIVATE_ENCAPSULATION, JSForm.MODULE_PRIVATE_ENCAPSULATION, JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION, JSForm.HIDE_FOUNDSET_ENCAPSULATION, JSForm.HIDE_CONTROLLER_ENCAPSULATION, JSForm.HIDE_ELEMENTS_ENCAPSULATION
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myDefaultForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION;

	var myPrivateForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION;

	var myModulePrivateForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION;

 var myHideDataprovidersForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION;

 var myHideFoundsetForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION;

 var myHideControllerForm = solutionModel.newForm('newForm6', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION;

	var myHideElementsForm = solutionModel.newForm('newForm7', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idPRIVATE_ENCAPSULATION
classnode
Table Row (tr)
idname
Table Cell (td)
PRIVATE_ENCAPSULATION
Table Row (tr)
iddes
Table Cell (td)
The constants to set or get the encapsulation property of a JSForm.
They are as follows: JSForm.DEFAULT_ENCAPSULATION, JSForm.PRIVATE_ENCAPSULATION, JSForm.MODULE_PRIVATE_ENCAPSULATION, JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION, JSForm.HIDE_FOUNDSET_ENCAPSULATION, JSForm.HIDE_CONTROLLER_ENCAPSULATION, JSForm.HIDE_ELEMENTS_ENCAPSULATION
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myDefaultForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myDefaultForm.encapsulation = JSForm.DEFAULT_ENCAPSULATION;

	var myPrivateForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myPrivateForm.encapsulation = JSForm.PRIVATE_ENCAPSULATION;

	var myModulePrivateForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myModulePrivateForm.encapsulation = JSForm.MODULE_PRIVATE_ENCAPSULATION;

 var myHideDataprovidersForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideDataprovidersForm.encapsulation = JSForm.HIDE_DATAPROVIDERS_ENCAPSULATION;

 var myHideFoundsetForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideFoundsetForm.encapsulation = JSForm.HIDE_FOUNDSET_ENCAPSULATION;

 var myHideControllerForm = solutionModel.newForm('newForm6', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideControllerForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION;

	var myHideElementsForm = solutionModel.newForm('newForm7', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myHideElementsForm.encapsulation = JSForm.HIDE_ELEMENTS_ENCAPSULATION;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idRECORD_VIEW
classnode
Table Row (tr)
idname
Table Cell (td)
RECORD_VIEW
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myListViewForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myListViewForm.view = JSForm.LIST_VIEW;

	var myLockedListViewForm = solutionModel.newForm('newForm2', 'myServer', 'myTable', 'myStyleName', false, 800, 600);	
	myLockedListViewForm.view = JSForm.LOCKED_LIST_VIEW;
	
	var myLockedRecordViewForm = solutionModel.newForm('newForm3', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myLockedRecordViewForm.view = JSForm.LOCKED_RECORD_VIEW;

	var myLockedTableViewForm = solutionModel.newForm('newForm4', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myLockedTableViewForm.view = JSForm.LOCKED_TABLE_VIEW;
	
	var myRecordViewForm = solutionModel.newForm('newForm5', 'myServer', 'myTable', 'myStyleName', false, 800, 600);
	myRecordViewForm.view = JSForm.RECORD_VIEW;
Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details
Table Body (tbody)
idborderType
classnode
Table Row (tr)
idname
Table Cell (td)
borderType
Table Row (tr)
iddes
Table Cell (td)
The type, color and style of border of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
//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.createBorder(1,'#ff0000');;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddataSource
classnode
Table Row (tr)
idname
Table Cell (td)
dataSource
Table Row (tr)
iddes
Table Cell (td)
The names of the database server and table that this form is linked to.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myForm = solutionModel.newForm('newForm', 'aServer', 'aTable', 'aStyleName', false, 800, 600)
	myForm.dataSource = 'db:/anotherServerName/anotherTableName'
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddefaultPageFormat
classnode
Table Row (tr)
idname
Table Cell (td)
defaultPageFormat
Table Row (tr)
iddes
Table Cell (td)
The default page format for the form.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idencapsulation
classnode
Table Row (tr)
idname
Table Cell (td)
encapsulation
Table Row (tr)
iddes
Table Cell (td)
Replace with description
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
myForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idextendsForm
classnode
Table Row (tr)
idname
Table Cell (td)
extendsForm
Table Row (tr)
iddes
Table Cell (td)
A JSForm instance representing the super form of this form, if this form has a super form.
Table Row (tr)
idret
Table Cell (td)
Returns
JSForm
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var subForm = solutionModel.newForm('childForm','myServer','myTable',null,true,800,600);
var superForm = solutionModel.newForm('childForm','myServer','myTable',null,true,800,600);
subForm.extendsForm = superForm;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idinitialSort
classnode
Table Row (tr)
idname
Table Cell (td)
initialSort
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('myForm','myServer','myTable',null,true,800,600);
form.initialSort = "column1 desc, column2 asc, column3 asc";
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idname
classnode
Table Row (tr)
idname
Table Cell (td)
name
Table Row (tr)
iddes
Table Cell (td)
The name of the form.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('myForm','myServer','myTable',null,true,800,600);
var formName = form.name;
application.output(formName);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idnamedFoundSet
classnode
Table Row (tr)
idname
Table Cell (td)
namedFoundSet
Table Row (tr)
iddes
Table Cell (td)
Property that tells the form to use a named foundset instead of the default foundset.
When "separate" as special value is specified the form will always create a copy of assigned foundset and therefor become separated from other foundsets
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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 = 'separate';
	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', '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 = 'empty';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idnavigator
classnode
Table Row (tr)
idname
Table Cell (td)
navigator
Table Row (tr)
iddes
Table Cell (td)

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)
idret
Table Cell (td)
Returns
JSForm
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var aForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 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', 'myServer', 'myTable', 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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDeleteAllRecordsCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onDeleteAllRecordsCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onNewRecordCmd = form.newFormMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }');
form.onDuplicateRecordCmd = form.newFormMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteRecordCmd = form.newFormMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteAllRecordsCmd = form.newFormMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDeleteRecordCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onDeleteRecordCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onNewRecordCmd = form.newFormMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }');
form.onDuplicateRecordCmd = form.newFormMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteRecordCmd = form.newFormMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteAllRecordsCmd = form.newFormMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDrag
classnode
Table Row (tr)
idname
Table Cell (td)
onDrag
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when (non Design Mode) dragging occurs.
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onDrag = form.newFormMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newFormMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newFormMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newFormMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDragEnd
classnode
Table Row (tr)
idname
Table Cell (td)
onDragEnd
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when (non Design Mode) dragging end occurs.
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onDrag = form.newFormMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newFormMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newFormMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newFormMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDragOver
classnode
Table Row (tr)
idname
Table Cell (td)
onDragOver
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when (non Design Mode) dragging over a component occurs.
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onDrag = form.newFormMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newFormMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newFormMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newFormMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDrop
classnode
Table Row (tr)
idname
Table Cell (td)
onDrop
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when (non Design Mode) dropping occurs.
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onDrag = form.newFormMethod('function onDrag(event) { application.output("onDrag intercepted from " + event.getSource()); }');
form.onDragEnd = form.newFormMethod('function onDragEnd(event) { application.output("onDragEnd intercepted from " + event.getSource()); }');
form.onDragOver = form.newFormMethod('function onDragOver(event) { application.output("onDragOver intercepted from " + event.getSource()); }');
form.onDrop = form.newFormMethod('function onDrop(event) { application.output("onDrop intercepted from " + event.getSource()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDuplicateRecordCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onDuplicateRecordCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onNewRecordCmd = form.newFormMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }');
form.onDuplicateRecordCmd = form.newFormMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteRecordCmd = form.newFormMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteAllRecordsCmd = form.newFormMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonElementFocusGained
classnode
Table Row (tr)
idname
Table Cell (td)
onElementFocusGained
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when focus is gained by a component inside the form.
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onElementFocusGained = form.newFormMethod('function onElementFocusGained(event) { application.output("onElementFocusGained intercepted from " + event.getSource()); }');
form.onElementFocusLost = form.newFormMethod('function onElementFocusLost(event) { application.output("onElementFocusLost intercepted from " + event.getSource()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonElementFocusLost
classnode
Table Row (tr)
idname
Table Cell (td)
onElementFocusLost
Table Row (tr)
iddes
Table Cell (td)
The method that gets triggered when focus is lost by a component inside the form.
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onElementFocusGained = form.newFormMethod('function onElementFocusGained(event) { application.output("onElementFocusGained intercepted from " + event.getSource()); }');
form.onElementFocusLost = form.newFormMethod('function onElementFocusLost(event) { application.output("onElementFocusLost intercepted from " + event.getSource()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonFindCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onFindCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onFindCmd = form.newFormMethod('function onFindCmd(event) { application.output("onFindCmd intercepted on " + event.getFormName()); }');
form.onSearchCmd = form.newFormMethod('function onSearchCmd(event) { application.output("onSearchCmd intercepted on " + event.getFormName()); }');
form.onShowAllRecordsCmd = form.newFormMethod('function onShowAllRecordsCmd(event) { application.output("onShowAllRecordsCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonHide
classnode
Table Row (tr)
idname
Table Cell (td)
onHide
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when another form is being activated.
NOTE: If the onHide method returns false, the form can be prevented from hiding.
For example, when using onHide with showFormInDialog, the form will not close by clicking the dialog close box (X).
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onShow = form.newFormMethod('function onShow(firstShow, event) { application.output("onShow intercepted on " + event.getFormName() + ". first show? " + firstShow); return false; }');
form.onHide = form.newFormMethod('function onHide(event) { application.output("onHide blocked on " + event.getFormName()); return false; }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonInvertRecordsCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onInvertRecordsCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onOmitRecordCmd = form.newFormMethod('function onOmitRecordCmd(event) { application.output("onOmitRecordCmd intercepted on " + event.getFormName()); }');
form.onShowOmittedRecordsCmd = form.newFormMethod('function onShowOmittedRecordsCmd(event) { application.output("onShowOmittedRecordsCmd intercepted on " + event.getFormName()); }');
form.onInvertRecordsCmd = form.newFormMethod('function onInvertRecordsCmd(event) { application.output("onInvertRecordsCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonLoad
classnode
Table Row (tr)
idname
Table Cell (td)
onLoad
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when a form is loaded/reloaded from the repository; used to alter elements, set globals, hide toolbars,
etc; onShow method can also be assigned.
NOTE: onShow should be used to access current foundset dataproviders; onLoad cannot be used because the foundset data is not loaded until after the form is loaded.
Also calls to loadRecords() should be done in the onShow method and not in the onLoad method
If you call loadRecords() in the onShow method, you may want to set the namedFoundSet property of the form to 'empty' to prevent the first default form query.
NOTE: the onLoad event bubbles down, meaning that the onLoad is first fired on the parent then on a tab in a tabpanel (and in tab of that tab panels if you are 3 deep)
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onLoad = form.newFormMethod('function onLoad(event) { application.output("onLoad intercepted on " + event.getFormName()); }');
form.onUnLoad = form.newFormMethod('function onUnLoad(event) { application.output("onUnLoad intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonNewRecordCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onNewRecordCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onNewRecordCmd = form.newFormMethod('function onNewRecordCmd(event) { application.output("onNewRecordCmd intercepted on " + event.getFormName()); }');
form.onDuplicateRecordCmd = form.newFormMethod('function onDuplicateRecordCmd(event) { application.output("onDuplicateRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteRecordCmd = form.newFormMethod('function onDeleteRecordCmd(event) { application.output("onDeleteRecordCmd intercepted on " + event.getFormName()); }');
form.onDeleteAllRecordsCmd = form.newFormMethod('function onDeleteAllRecordsCmd(event) { application.output("onDeleteAllRecordsCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonNextRecordCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onNextRecordCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onPreviousRecordCmd = form.newFormMethod('function onPreviousRecordCmd(event) { application.output("onPreviousRecordCmd intercepted on " + event.getFormName()); }');
form.onNextRecordCmd = form.newFormMethod('function onNextRecordCmd(event) { application.output("onNextRecordCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonOmitRecordCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onOmitRecordCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onOmitRecordCmd = form.newFormMethod('function onOmitRecordCmd(event) { application.output("onOmitRecordCmd intercepted on " + event.getFormName()); }');
form.onShowOmittedRecordsCmd = form.newFormMethod('function onShowOmittedRecordsCmd(event) { application.output("onShowOmittedRecordsCmd intercepted on " + event.getFormName()); }');
form.onInvertRecordsCmd = form.newFormMethod('function onInvertRecordsCmd(event) { application.output("onInvertRecordsCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonPreviousRecordCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onPreviousRecordCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onPreviousRecordCmd = form.newFormMethod('function onPreviousRecordCmd(event) { application.output("onPreviousRecordCmd intercepted on " + event.getFormName()); }');
form.onNextRecordCmd = form.newFormMethod('function onNextRecordCmd(event) { application.output("onNextRecordCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonPrintPreviewCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onPrintPreviewCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onPrintPreviewCmd = form.newFormMethod('function onPrintPreviewCmd(event) { application.output("onPrintPreviewCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonRecordEditStart
classnode
Table Row (tr)
idname
Table Cell (td)
onRecordEditStart
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onRecordEditStart = form.newFormMethod('function onRecordEditStart(event) { application.output("onRecordEditStart intercepted on " + event.getFormName()); }');
form.onRecordEditStop = form.newFormMethod('function onRecordEditStop(record, event) { application.output("onRecordEditStop intercepted on " + event.getFormName() + ". record is: " + record); }');
form.onRecordSelection = form.newFormMethod('function onRecordSelection(event) { application.output("onRecordSelection intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonRecordEditStop
classnode
Table Row (tr)
idname
Table Cell (td)
onRecordEditStop
Table Row (tr)
iddes
Table Cell (td)
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); can return false (for example as part of a validation) where a condition must be changed to return true.
NOTE: The name of this property has been changed from onRecordSave.
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onRecordEditStart = form.newFormMethod('function onRecordEditStart(event) { application.output("onRecordEditStart intercepted on " + event.getFormName()); }');
form.onRecordEditStop = form.newFormMethod('function onRecordEditStop(record, event) { application.output("onRecordEditStop intercepted on " + event.getFormName() + ". record is: " + record); }');
form.onRecordSelection = form.newFormMethod('function onRecordSelection(event) { application.output("onRecordSelection intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonRecordSelection
classnode
Table Row (tr)
idname
Table Cell (td)
onRecordSelection
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered each time a record is selected.
If a form is in List view or Special table view - when the user clicks on it.
In Record view - after the user navigates to another record using the slider or clicks up or down for next/previous record.
NOTE: Data and Servoy tag values are returned when the onRecordSelection method is executed.
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onRecordEditStart = form.newFormMethod('function onRecordEditStart(event) { application.output("onRecordEditStart intercepted on " + event.getFormName()); }');
form.onRecordEditStop = form.newFormMethod('function onRecordEditStop(record, event) { application.output("onRecordEditStop intercepted on " + event.getFormName() + ". record is: " + record); }');
form.onRecordSelection = form.newFormMethod('function onRecordSelection(event) { application.output("onRecordSelection intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonRender
classnode
Table Row (tr)
idname
Table Cell (td)
onRender
Table Row (tr)
iddes
Table Cell (td)
The method that is executed when the component is rendered.
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onRender = form.newFormMethod('function onRender(event) { event.getElement().bgcolor = \'#00ff00\' }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonResize
classnode
Table Row (tr)
idname
Table Cell (td)
onResize
Table Row (tr)
iddes
Table Cell (td)
The method that gets triggered when resize occurs.
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onResize = form.newFormMethod('function onResize(event) { application.output("onResize intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonSearchCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onSearchCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onFindCmd = form.newFormMethod('function onFindCmd(event) { application.output("onFindCmd intercepted on " + event.getFormName()); }');
form.onSearchCmd = form.newFormMethod('function onSearchCmd(event) { application.output("onSearchCmd intercepted on " + event.getFormName()); }');
form.onShowAllRecordsCmd = form.newFormMethod('function onShowAllRecordsCmd(event) { application.output("onShowAllRecordsCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonShow
classnode
Table Row (tr)
idname
Table Cell (td)
onShow
Table Row (tr)
iddes
Table Cell (td)

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

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

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

Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onShow = form.newFormMethod('function onShow(firstShow, event) { application.output("onShow intercepted on " + event.getFormName() + ". first show? " + firstShow); return false; }');
form.onHide = form.newFormMethod('function onHide(event) { application.output("onHide blocked on " + event.getFormName()); return false; }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonShowAllRecordsCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onShowAllRecordsCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onFindCmd = form.newFormMethod('function onFindCmd(event) { application.output("onFindCmd intercepted on " + event.getFormName()); }');
form.onSearchCmd = form.newFormMethod('function onSearchCmd(event) { application.output("onSearchCmd intercepted on " + event.getFormName()); }');
form.onShowAllRecordsCmd = form.newFormMethod('function onShowAllRecordsCmd(event) { application.output("onShowAllRecordsCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonShowOmittedRecordsCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onShowOmittedRecordsCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onOmitRecordCmd = form.newFormMethod('function onOmitRecordCmd(event) { application.output("onOmitRecordCmd intercepted on " + event.getFormName()); }');
form.onShowOmittedRecordsCmd = form.newFormMethod('function onShowOmittedRecordsCmd(event) { application.output("onShowOmittedRecordsCmd intercepted on " + event.getFormName()); }');
form.onInvertRecordsCmd = form.newFormMethod('function onInvertRecordsCmd(event) { application.output("onInvertRecordsCmd intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonSortCmd
classnode
Table Row (tr)
idname
Table Cell (td)
onSortCmd
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onSortCmd = form.newFormMethod('function onSortCmd(dataProviderID, asc, event) { application.output("onSortCmd intercepted on " + event.getFormName() + ". data provider: " + dataProviderID + ". asc: " + asc); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonUnLoad
classnode
Table Row (tr)
idname
Table Cell (td)
onUnLoad
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSMethod
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.onLoad = form.newFormMethod('function onLoad(event) { application.output("onLoad intercepted on " + event.getFormName()); }');
form.onUnLoad = form.newFormMethod('function onUnLoad(event) { application.output("onUnLoad intercepted on " + event.getFormName()); }');
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idpaperPrintScale
classnode
Table Row (tr)
idname
Table Cell (td)
paperPrintScale
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('myForm','myServer','myTable',null,true,800,600);
if (form.paperPrintScale < 100)
	form.paperPrintScale = 100;
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idscrollbars
classnode
Table Row (tr)
idname
Table Cell (td)
scrollbars
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('myForm','myServer','myTable',null,true,1000,600);
form.scrollbars = SM_SCROLLBAR.VERTICAL_SCROLLBAR_NEVER; 
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idserverName
classnode
Table Row (tr)
idname
Table Cell (td)
serverName
Table Row (tr)
iddes
Table Cell (td)
Get the server name used by this form.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('myForm','myServer','myTable',null,true,800,600);
form.serverName = 'anotherServerName';
var theServerName = form.getServerName();
application.output(theServerName);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idshowInMenu
classnode
Table Row (tr)
idname
Table Cell (td)
showInMenu
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var aForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var anotherForm= solutionModel.newForm('newForm2', 'myServer', 'myTable', 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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idstyleClass
classnode
Table Row (tr)
idname
Table Cell (td)
styleClass
Table Row (tr)
iddes
Table Cell (td)
The Cascading Style Sheet (CSS) class name applied to the form.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var aForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idstyleName
classnode
Table Row (tr)
idname
Table Cell (td)
styleName
Table Row (tr)
iddes
Table Cell (td)
The name of the Servoy style that is being used on the form.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var aForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', 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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtableName
classnode
Table Row (tr)
idname
Table Cell (td)
tableName
Table Row (tr)
iddes
Table Cell (td)
The [name of the table/SQL view].[the name of the database server connection] the form is based on.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var aForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	aForm.tableName = 'anotherTableOfMine'
	if (forms['newForm1'].controller.find())
	{
		columnTextDataProvider = '=aSearchedValue'
		columnNumberDataProvider = '>10';
		forms['newForm1'].controller.search()
	}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtitleText
classnode
Table Row (tr)
idname
Table Cell (td)
titleText
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myForm = solutionModel.newForm('newForm', 'aServer', 'aTable', '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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtransparent
classnode
Table Row (tr)
idname
Table Cell (td)
transparent
Table Row (tr)
iddes
Table Cell (td)
When set, the form is transparent.
Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.newForm('myForm','myServer','myTable',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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idview
classnode
Table Row (tr)
idname
Table Cell (td)
view
Table Row (tr)
iddes
Table Cell (td)

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)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
myForm.view = JSForm.RECORD_VIEW;
forms['newForm1'].controller.show();
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idwidth
classnode
Table Row (tr)
idname
Table Cell (td)
width
Table Row (tr)
iddes
Table Cell (td)
The width of the form in pixels.
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var myForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	forms['newForm1'].controller.show();
	myForm.width = 120;
 forms['newForm1'].controller.recreateUI();
Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idgetBean
classnode
Table Row (tr)
idname
Table Cell (td)
getBean
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSBean
Span
stylefloat: left; font-weight: bold;
idiets
getBean
Span
stylefloat: left;
idiets
(name)
Table Row (tr)
iddes
Table Cell (td)
Returns a JSBean that has the given name.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{String} name – the specified name of the bean
Table Row (tr)
idret
Table Cell (td)
Returns
JSBean – a JSBean object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var btn = myForm.getBean("mybean");
application.output(mybean.className);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetBeans
classnode
Table Row (tr)
idname
Table Cell (td)
getBeans
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSBean[]
Span
stylefloat: left; font-weight: bold;
idiets
getBeans
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns all JSBeans of this form.
Table Row (tr)
idret
Table Cell (td)
Returns
JSBean[] – the list of all JSbuttons on this forms
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var beans = myForm.getBeans();
for (var b in beans)
{
		if (beans[b].name != null) 
			application.output(beans[b].name);
}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetBeans-Boolean
classnode
Table Row (tr)
idname
Table Cell (td)
getBeans
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSBean[]
Span
stylefloat: left; font-weight: bold;
idiets
getBeans
Span
stylefloat: left;
idiets
(returnInheritedElements)
Table Row (tr)
iddes
Table Cell (td)
Returns all JSBeans of this form.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from parent form
Table Row (tr)
idret
Table Cell (td)
Returns
JSBean[] – the list of all JSbuttons on this forms
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var beans = myForm.getBeans();
for (var b in beans)
{
		if (beans[b].name != null) 
			application.output(beans[b].name);
}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetBodyPart
classnode
Table Row (tr)
idname
Table Cell (td)
getBodyPart
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSPart
Span
stylefloat: left; font-weight: bold;
idiets
getBodyPart
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Retrieves the Body part of the form.
Table Row (tr)
idret
Table Cell (td)
Returns
JSPart – A JSPart instance corresponding to the Body part of the form.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.getBodyPart().background = 'blue';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetButton
classnode
Table Row (tr)
idname
Table Cell (td)
getButton
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSButton
Span
stylefloat: left; font-weight: bold;
idiets
getButton
Span
stylefloat: left;
idiets
(name)
Table Row (tr)
iddes
Table Cell (td)
Returns a JSButton that has the given name.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{String} name – the specified name of the button
Table Row (tr)
idret
Table Cell (td)
Returns
JSButton – a JSButton object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var btn = myForm.getButton("hello");
application.output(btn.text);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetButtons
classnode
Table Row (tr)
idname
Table Cell (td)
getButtons
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSButton[]
Span
stylefloat: left; font-weight: bold;
idiets
getButtons
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns all JSButtons of this form, including the ones without a name.
Table Row (tr)
idret
Table Cell (td)
Returns
JSButton[] – the list of all JSbuttons on this forms
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var buttons = myForm.getButtons();
for (var b in buttons)
{
		if (buttons[b].name != null) 
			application.output(buttons[b].name);
		else
			application.output(buttons[b].text + " has no name ");
}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetButtons-Boolean
classnode
Table Row (tr)
idname
Table Cell (td)
getButtons
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSButton[]
Span
stylefloat: left; font-weight: bold;
idiets
getButtons
Span
stylefloat: left;
idiets
(returnInheritedElements)
Table Row (tr)
iddes
Table Cell (td)
Returns all JSButtons of this form, including the ones without a name.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from parent form
Table Row (tr)
idret
Table Cell (td)
Returns
JSButton[] – the list of all JSbuttons on this forms
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var buttons = myForm.getButtons();
for (var b in buttons)
{
		if (buttons[b].name != null) 
			application.output(buttons[b].name);
		else
			application.output(buttons[b].text + " has no name ");
}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetComponent
classnode
Table Row (tr)
idname
Table Cell (td)
getComponent
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSComponent
Span
stylefloat: left; font-weight: bold;
idiets
getComponent
Span
stylefloat: left;
idiets
(name)
Table Row (tr)
iddes
Table Cell (td)
Returns a JSComponent that has the given name; if found it will be a JSField, JSLabel, JSButton, JSPortal, JSBean or JSTabPanel.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{String} name – the specified name of the component
Table Row (tr)
idret
Table Cell (td)
Returns
JSComponent – a JSComponent object (might be a JSField, JSLabel, JSButton, JSPortal, JSBean or JSTabPanel)
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var cmp = frm.getComponent("componentName");
	application.output("Component type and name: " + cmp);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetComponents
classnode
Table Row (tr)
idname
Table Cell (td)
getComponents
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSComponent[]
Span
stylefloat: left; font-weight: bold;
idiets
getComponents
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean or JSTabPanel.
Table Row (tr)
idret
Table Cell (td)
Returns
JSComponent[] – an array of all the JSComponents on the form.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm("myForm");
	var components = form.getComponents();
	for (var i in components)
		application.output("Component type and name: " + components[i]);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetComponents-Boolean
classnode
Table Row (tr)
idname
Table Cell (td)
getComponents
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSComponent[]
Span
stylefloat: left; font-weight: bold;
idiets
getComponents
Span
stylefloat: left;
idiets
(returnInheritedElements)
Table Row (tr)
iddes
Table Cell (td)
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)
idprs
Table Cell (td)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from the parent form
Table Row (tr)
idret
Table Cell (td)
Returns
JSComponent[] – an array of all the JSComponents on the form.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm("myForm");
	var components = form.getComponents();
	for (var i in components)
		application.output("Component type and name: " + components[i]);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetField
classnode
Table Row (tr)
idname
Table Cell (td)
getField
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSField
Span
stylefloat: left; font-weight: bold;
idiets
getField
Span
stylefloat: left;
idiets
(name)
Table Row (tr)
iddes
Table Cell (td)
The field with the specified name.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{String} name – the specified name of the field
Table Row (tr)
idret
Table Cell (td)
Returns
JSField – a JSField object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var form = solutionModel.getForm("myForm");
	var field = form.getField("myField");
	application.output(field.dataProviderID);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetFields
classnode
Table Row (tr)
idname
Table Cell (td)
getFields
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSField[]
Span
stylefloat: left; font-weight: bold;
idiets
getFields
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns all JSField objects of this form, including the ones without a name.
Table Row (tr)
idret
Table Cell (td)
Returns
JSField[] – all JSField objects of this form
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var fields = frm.getFields();
	for (var f in fields)
	{
		var fname = fields[f].name;
		if (fname != null)
			application.output(fname);
	}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetFields-Boolean
classnode
Table Row (tr)
idname
Table Cell (td)
getFields
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSField[]
Span
stylefloat: left; font-weight: bold;
idiets
getFields
Span
stylefloat: left;
idiets
(returnInheritedElements)
Table Row (tr)
iddes
Table Cell (td)
Returns all JSField objects of this form, including the ones without a name.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from the parent form
Table Row (tr)
idret
Table Cell (td)
Returns
JSField[] – all JSField objects of this form
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var fields = frm.getFields();
	for (var f in fields)
	{
		var fname = fields[f].name;
		if (fname != null)
			application.output(fname);
	}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetFooterPart
classnode
Table Row (tr)
idname
Table Cell (td)
getFooterPart
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSPart
Span
stylefloat: left; font-weight: bold;
idiets
getFooterPart
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Retrieves the Footer part of the form.
Table Row (tr)
idret
Table Cell (td)
Returns
JSPart – A JSPart instance corresponding to the Footer part of the form.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.getFooterPart().background = 'magenta';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetFormMethod
classnode
Table Row (tr)
idname
Table Cell (td)
getFormMethod
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSMethod
Span
stylefloat: left; font-weight: bold;
idiets
getFormMethod
Span
stylefloat: left;
idiets
(name)
Table Row (tr)
iddes
Table Cell (td)
Gets an existing form method for the given name.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{String} name – the specified name of the method
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod – a JSMethod object (or null if the method with the specified name does not exist)
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var method = frm.getFormMethod("myMethod");
	application.output(method.code);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetFormMethods
classnode
Table Row (tr)
idname
Table Cell (td)
getFormMethods
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSMethod[]
Span
stylefloat: left; font-weight: bold;
idiets
getFormMethods
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns all existing form methods for this form.
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod[] – all form methods for the form
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var methods = frm.getFormMethods();
	for (var m in methods)
		application.output(methods[m].getName());
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetFormMethods-Boolean
classnode
Table Row (tr)
idname
Table Cell (td)
getFormMethods
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSMethod[]
Span
stylefloat: left; font-weight: bold;
idiets
getFormMethods
Span
stylefloat: left;
idiets
(returnInheritedElements)
Table Row (tr)
iddes
Table Cell (td)
Returns all existing form methods for this form.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from the parent form
Table Row (tr)
idret
Table Cell (td)
Returns
JSMethod[] – all form methods for the form
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var methods = frm.getFormMethods();
	for (var m in methods)
		application.output(methods[m].getName());
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetFormVariable
classnode
Table Row (tr)
idname
Table Cell (td)
getFormVariable
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSVariable
Span
stylefloat: left; font-weight: bold;
idiets
getFormVariable
Span
stylefloat: left;
idiets
(name)
Table Row (tr)
iddes
Table Cell (td)
Gets an existing form variable for the given name.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{String} name – the specified name of the variable
Table Row (tr)
idret
Table Cell (td)
Returns
JSVariable – a JSVariable object
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var fvariable = frm.getFormVariable("myVarName");
	application.output(fvariable.name + " has the default value of " + fvariable.defaultValue);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetFormVariables
classnode
Table Row (tr)
idname
Table Cell (td)
getFormVariables
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSVariable[]
Span
stylefloat: left; font-weight: bold;
idiets
getFormVariables
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
An array consisting of all form variables for this form.
Table Row (tr)
idret
Table Cell (td)
Returns
JSVariable[] – an array of all variables on this form
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var variables = frm.getFormVariables();
	for (var i in variables)
		application.output(variables[i].name);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetFormVariables-Boolean
classnode
Table Row (tr)
idname
Table Cell (td)
getFormVariables
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSVariable[]
Span
stylefloat: left; font-weight: bold;
idiets
getFormVariables
Span
stylefloat: left;
idiets
(returnInheritedElements)
Table Row (tr)
iddes
Table Cell (td)
An array consisting of all form variables for this form.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from the parent form
Table Row (tr)
idret
Table Cell (td)
Returns
JSVariable[] – an array of all variables on this form
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var variables = frm.getFormVariables();
	for (var i in variables)
		application.output(variables[i].name);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetHeaderPart
classnode
Table Row (tr)
idname
Table Cell (td)
getHeaderPart
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSPart
Span
stylefloat: left; font-weight: bold;
idiets
getHeaderPart
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Retrieves the Header part of the form.
Table Row (tr)
idret
Table Cell (td)
Returns
JSPart – A JSPart instance corresponding to the Header part of the form.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.getHeaderPart().background = 'orange';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetLabel
classnode
Table Row (tr)
idname
Table Cell (td)
getLabel
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSLabel
Span
stylefloat: left; font-weight: bold;
idiets
getLabel
Span
stylefloat: left;
idiets
(name)
Table Row (tr)
iddes
Table Cell (td)
Returns a JSLabel that has the given name.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{String} name – the specified name of the label
Table Row (tr)
idret
Table Cell (td)
Returns
JSLabel – a JSLabel object (or null if the label with the specified name does not exist)
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var label = frm.getLabel("myLabel");
	application.output(label.text);
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetLabels
classnode
Table Row (tr)
idname
Table Cell (td)
getLabels
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSLabel[]
Span
stylefloat: left; font-weight: bold;
idiets
getLabels
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Returns all JSLabels of this form (not including its super form), including the ones without a name.
Table Row (tr)
idret
Table Cell (td)
Returns
JSLabel[] – all JSLabels on this form
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var labels = frm.getLabels();
	for (var i in labels)
	{
		var lname = labels[i].name;
		if (lname != null)
			application.output(lname);
	}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetLabels-Boolean
classnode
Table Row (tr)
idname
Table Cell (td)
getLabels
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSLabel[]
Span
stylefloat: left; font-weight: bold;
idiets
getLabels
Span
stylefloat: left;
idiets
(returnInheritedElements)
Table Row (tr)
iddes
Table Cell (td)
Returns all JSLabels of this form (optionally including it super forms labels), including the ones without a name.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{Boolean} returnInheritedElements – true to also return the elements from parent form
Table Row (tr)
idret
Table Cell (td)
Returns
JSLabel[] – all JSLabels on this form
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
var frm = solutionModel.getForm("myForm");
	var labels = frm.getLabels();
	for (var i in labels)
	{
		var lname = labels[i].name;
		if (lname != null)
			application.output(lname);
	}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetLeadingGrandSummaryPart
classnode
Table Row (tr)
idname
Table Cell (td)
getLeadingGrandSummaryPart
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSPart
Span
stylefloat: left; font-weight: bold;
idiets
getLeadingGrandSummaryPart
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Retrieves the Leading Grand Summary part of the form.
Table Row (tr)
idret
Table Cell (td)
Returns
JSPart – A JSPart instance corresponding to the Leading Grand Summary part of the form.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.getLeadingGrandSummaryPart().background = 'yellow';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetLeadingSubSummaryParts
classnode
Table Row (tr)
idname
Table Cell (td)
getLeadingSubSummaryParts
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSPart[]
Span
stylefloat: left; font-weight: bold;
idiets
getLeadingSubSummaryParts
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
Gets an array of the Leading Subsummary parts of the form, ordered by their height from top == 0 to bottom.
Table Row (tr)
idret
Table Cell (td)
Returns
JSPart[] – An array of JSPart instances corresponding to the Leading Subsummary parts of the form.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.getLeadingSubSummaryParts()[0].background = 'green';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetPart-Number
classnode
Table Row (tr)
idname
Table Cell (td)
getPart
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSPart
Span
stylefloat: left; font-weight: bold;
idiets
getPart
Span
stylefloat: left;
idiets
(type)
Table Row (tr)
iddes
Table Cell (td)
Gets a part of the form from the given type (see JSPart constants).
Table Row (tr)
idprs
Table Cell (td)
Parameters
{Number} type – The type of the part to retrieve.
Table Row (tr)
idret
Table Cell (td)
Returns
JSPart – A JSPart instance representing the retrieved form part.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.getPart(JSPart.HEADER).background = 'red';
form.getPart(JSPart.LEADING_SUBSUMMARY, 160).background = 'red';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetPart-Number_Number
classnode
Table Row (tr)
idname
Table Cell (td)
getPart
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSPart
Span
stylefloat: left; font-weight: bold;
idiets
getPart
Span
stylefloat: left;
idiets
(type, height)
Table Row (tr)
iddes
Table Cell (td)
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)
idprs
Table Cell (td)
Parameters
{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)
idret
Table Cell (td)
Returns
JSPart – A JSPart instance representing the retrieved form part.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
form.getPart(JSPart.HEADER).background = 'red';
form.getPart(JSPart.LEADING_SUBSUMMARY, 160).background = 'red';
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetPartYOffset-Number
classnode
Table Row (tr)
idname
Table Cell (td)
getPartYOffset
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Number
Span
stylefloat: left; font-weight: bold;
idiets
getPartYOffset
Span
stylefloat: left;
idiets
(type)
Table Row (tr)
iddes
Table Cell (td)
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)
idprs
Table Cell (td)
Parameters
{Number} type – The type of the part whose Y offset will be returned.
Table Row (tr)
idret
Table Cell (td)
Returns
Number – A number holding the Y offset of the specified form part.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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('test'));
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetPartYOffset-Number_Number
classnode
Table Row (tr)
idname
Table Cell (td)
getPartYOffset
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
Number
Span
stylefloat: left; font-weight: bold;
idiets
getPartYOffset
Span
stylefloat: left;
idiets
(type, height)
Table Row (tr)
iddes
Table Cell (td)
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)
idprs
Table Cell (td)
Parameters
{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)
idret
Table Cell (td)
Returns
Number – A number holding the Y offset of the specified form part.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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('test'));
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetParts
classnode
Table Row (tr)
idname
Table Cell (td)
getParts
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSPart[]
Span
stylefloat: left; font-weight: bold;
idiets
getParts
Span
stylefloat: left;
idiets
()
Table Row (tr)
iddes
Table Cell (td)
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)
idret
Table Cell (td)
Returns
JSPart[] – An array of JSPart instances corresponding to the parts of the form.
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
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)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetParts-Boolean
classnode
Table Row (tr)
idname
Table Cell (td)
getParts
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSPart[]
Span
stylefloat: left; font-weight: bold;
idiets
getParts
Span
stylefloat: left;
idiets
(returnInheritedElements)
Table Row (tr)
iddes
Table Cell (td)
Gets all the parts from the form (optionally also from the parent form), ordered by there height (lowerbound) property, from top == 0 to bottom.