Child pages
  • JSForm
Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 6 Next »


Unknown macro: {table}

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

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

Constants Summary

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

Number

Unknown macro: {td}

DEFAULT_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.

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

Number

Unknown macro: {td}

HIDE_CONTROLLER_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.

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

Number

Unknown macro: {td}

HIDE_DATAPROVIDERS_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.

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

Number

Unknown macro: {td}

HIDE_ELEMENTS_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.

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

Number

Unknown macro: {td}

HIDE_FOUNDSET_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.

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

Number

Unknown macro: {td}

LIST_VIEW
The constants to set or get the view property of a JSForm.

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

Number

Unknown macro: {td}

LOCKED_LIST_VIEW
The constants to set or get the view property of a JSForm.

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

Number

Unknown macro: {td}

LOCKED_RECORD_VIEW
The constants to set or get the view property of a JSForm.

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

Number

Unknown macro: {td}

LOCKED_TABLE_VIEW
The constants to set or get the view property of a JSForm.

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

Number

Unknown macro: {td}

MODULE_PRIVATE_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.

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

Number

Unknown macro: {td}

PRIVATE_ENCAPSULATION
The constants to set or get the encapsulation property of a JSForm.

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

Number

Unknown macro: {td}

RECORD_VIEW
The constants to set or get the view property of a JSForm.


Unknown macro: {table}

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

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

Property Summary

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

String

Unknown macro: {td}

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

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

String

Unknown macro: {td}

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

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

String

Unknown macro: {td}

defaultPageFormat
The default page format for the form.

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

Number

Unknown macro: {td}

encapsulation

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

JSForm

Unknown macro: {td}

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

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

String

Unknown macro: {td}

initialSort
The default sort order only when the form loads.

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

String

Unknown macro: {td}

name
The name of the form.

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

String

Unknown macro: {td}

namedFoundSet
Property that tells the form to use a named foundset instead of the default foundset.

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

JSForm

Unknown macro: {td}

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

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

JSMethod

Unknown macro: {td}

onDeleteAllRecordsCmd
The method that overrides the Servoy menu item Select > Delete All.

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

JSMethod

Unknown macro: {td}

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

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

JSMethod

Unknown macro: {td}

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

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

JSMethod

Unknown macro: {td}

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

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

JSMethod

Unknown macro: {td}

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

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

JSMethod

Unknown macro: {td}

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

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

JSMethod

Unknown macro: {td}

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

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

JSMethod

Unknown macro: {td}

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

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

JSMethod

Unknown macro: {td}

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

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

JSMethod

Unknown macro: {td}

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

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

JSMethod

Unknown macro: {td}

onHide
The method that is triggered when another form is being activated.

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

JSMethod

Unknown macro: {td}

onInvertRecordsCmd
The method that overrides the Servoy menu item Select > Invert Records.

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

JSMethod

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

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

JSMethod

Unknown macro: {td}

onNewRecordCmd
The method that overrides the Servoy menu item Select > New Record (or keyboard shortcut).

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

JSMethod

Unknown macro: {td}

onNextRecordCmd
The method that overrides the Servoy menu item Select > Next Record.

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

JSMethod

Unknown macro: {td}

onOmitRecordCmd
The method that overrides the Servoy menu item Select > Omit Record.

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

JSMethod

Unknown macro: {td}

onPreviousRecordCmd
The method that overrides the Servoy menu item Select > Previous Record.

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

JSMethod

Unknown macro: {td}

onPrintPreviewCmd
The method that overrides the Servoy menu item File > Print Preview.

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

JSMethod

Unknown macro: {td}

onRecordEditStart
The method that is triggered when a user clicks into a column on the form.

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

JSMethod

Unknown macro: {td}

onRecordEditStop
The method that is triggered when a record is being saved.

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

JSMethod

Unknown macro: {td}

onRecordSelection
The method that is triggered each time a record is selected.

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

JSMethod

Unknown macro: {td}

onRender
The method that is executed when the component is rendered.

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

JSMethod

Unknown macro: {td}

onResize
The method that gets triggered when resize occurs.

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

JSMethod

Unknown macro: {td}

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

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

JSMethod

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

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

JSMethod

Unknown macro: {td}

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

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

JSMethod

Unknown macro: {td}

onShowOmittedRecordsCmd
The method that overrides the Servoy menu item Select > Show Omitted Records.

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

JSMethod

Unknown macro: {td}

onSortCmd
The method that overrides the Servoy menu item Select > Sort.

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

JSMethod

Unknown macro: {td}

onUnLoad
The method that is triggered when a form is unloaded from the repository.

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

Number

Unknown macro: {td}

paperPrintScale
The percentage value the printed page is enlarged or reduced to; the size of the printed form
is inversely proportional.

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

Number

Unknown macro: {td}

scrollbars
Scrollbar options for the vertical and horizontal scrollbars.

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

String

Unknown macro: {td}

serverName
Get the server name used by this form.

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

Boolean

Unknown macro: {td}

showInMenu
When set, the form is displayed under the Window menu.

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

String

Unknown macro: {td}

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

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

String

Unknown macro: {td}

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

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

String

Unknown macro: {td}

tableName
The [name of the table/SQL view].

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

String

Unknown macro: {td}

titleText
The text that displays in the title bar of the form window.

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

Boolean

Unknown macro: {td}

transparent
When set, the form is transparent.

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

Number

Unknown macro: {td}

view
The default form view mode.

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

Number

Unknown macro: {td}

width
The width of the form in pixels.


Unknown macro: {table}

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

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

Method Summary

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

JSBean

Unknown macro: {td}

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

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

JSBean[]

Unknown macro: {td}

getBeans()
Returns all JSBeans of this form.

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

JSBean[]

Unknown macro: {td}

getBeans(returnInheritedElements)
Returns all JSBeans of this form.

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

JSPart

Unknown macro: {td}

getBodyPart()
Retrieves the Body part of the form.

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

JSButton

Unknown macro: {td}

getButton(name)
Returns a JSButton that has the given name.

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

JSButton[]

Unknown macro: {td}

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

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

JSButton[]

Unknown macro: {td}

getButtons(returnInheritedElements)
Returns all JSButtons of this form, including the ones without a name.

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

JSComponent

Unknown macro: {td}

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

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

JSComponent[]

Unknown macro: {td}

getComponents()
Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean or JSTabPanel.

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

JSComponent[]

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

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

JSField

Unknown macro: {td}

getField(name)
The field with the specified name.

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

JSField[]

Unknown macro: {td}

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

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

JSField[]

Unknown macro: {td}

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

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

JSPart

Unknown macro: {td}

getFooterPart()
Retrieves the Footer part of the form.

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

JSMethod

Unknown macro: {td}

getFormMethod(name)
Gets an existing form method for the given name.

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

JSMethod[]

Unknown macro: {td}

getFormMethods()
Returns all existing form methods for this form.

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

JSMethod[]

Unknown macro: {td}

getFormMethods(returnInheritedElements)
Returns all existing form methods for this form.

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

JSVariable

Unknown macro: {td}

getFormVariable(name)
Gets an existing form variable for the given name.

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

JSVariable[]

Unknown macro: {td}

getFormVariables()
An array consisting of all form variables for this form.

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

JSVariable[]

Unknown macro: {td}

getFormVariables(returnInheritedElements)
An array consisting of all form variables for this form.

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

JSPart

Unknown macro: {td}

getHeaderPart()
Retrieves the Header part of the form.

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

JSLabel

Unknown macro: {td}

getLabel(name)
Returns a JSLabel that has the given name.

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

JSLabel[]

Unknown macro: {td}

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

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

JSLabel[]

Unknown macro: {td}

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

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

JSPart

Unknown macro: {td}

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

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

JSPart[]

Unknown macro: {td}

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

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

JSPart

Unknown macro: {td}

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

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

JSPart

Unknown macro: {td}

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

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

Number

Unknown macro: {td}

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

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

Number

Unknown macro: {td}

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

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

JSPart[]

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

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

JSPart[]

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

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

JSPortal

Unknown macro: {td}

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

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

JSPortal[]

Unknown macro: {td}

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

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

JSPortal[]

Unknown macro: {td}

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

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

JSTabPanel

Unknown macro: {td}

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

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

JSTabPanel[]

Unknown macro: {td}

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

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

JSTabPanel[]

Unknown macro: {td}

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

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

JSPart

Unknown macro: {td}

getTitleFooterPart()
Retrieves the Title Footer part of the form.

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

JSPart

Unknown macro: {td}

getTitleHeaderPart()
Retrieves the Title Header part of the form.

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

JSPart

Unknown macro: {td}

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

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

JSPart[]

Unknown macro: {td}

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

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

UUID

Unknown macro: {td}

getUUID()
Returns the UUID of this form.

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

JSBean

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

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

JSButton

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

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

JSField

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

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

JSField

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

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

JSField

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

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

JSField

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

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

JSPart

Unknown macro: {td}

newFooterPart()
Creates a new Footer part on the form.

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

JSMethod

Unknown macro: {td}

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

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

JSVariable

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

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

JSPart

Unknown macro: {td}

newHeaderPart()
Creates a new Header part on the form.

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

JSField

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

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

JSField

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

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

JSLabel

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

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

JSLabel

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

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

JSPart

Unknown macro: {td}

newLeadingGrandSummaryPart()
Creates a new Leading Grand Summary part on the form.

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

JSPart

Unknown macro: {td}

newLeadingSubSummaryPart()
Creates a new Leading Subsummary part on the form.

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

JSPart

Unknown macro: {td}

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

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

JSField

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

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

JSPortal

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

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

JSField

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

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

JSField

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

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

JSTabPanel

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

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

JSField

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

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

JSField

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

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

JSPart

Unknown macro: {td}

newTitleFooterPart()
Creates a new Title Footer part on the form.

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

JSPart

Unknown macro: {td}

newTitleHeaderPart()
Creates a new Title Header part on the form.

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

JSPart

Unknown macro: {td}

newTrailingGrandSummaryPart()
Creates a new Trailing Grand Summary part on the form.

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

JSPart

Unknown macro: {td}

newTrailingSubSummaryPart()
Creates a new Trailing Subsummary part on the form.

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

JSField

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

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

Boolean

Unknown macro: {td}

removeBean(name)
Removes a JSBean that has the specified name.

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

Boolean

Unknown macro: {td}

removeButton(name)
Removes a JSButton that has the specified name.

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

Boolean

Unknown macro: {td}

removeComponent(name)
Removes a component (JSLabel, JSButton, JSField, JSPortal, JSBean, JSTabpanel) that has the given name.

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

Boolean

Unknown macro: {td}

removeField(name)
Removes a JSField that has the given name.

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

Boolean

Unknown macro: {td}

removeLabel(name)
Removes a JSLabel that has the given name.

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

Boolean

Unknown macro: {td}

removePart(type)
Removes a JSPart of the given type.

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

Boolean

Unknown macro: {td}

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

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

Boolean

Unknown macro: {td}

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

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

Boolean

Unknown macro: {td}

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


Unknown macro: {table}

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

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

Constants Details

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

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

Returns
Number

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

Sample

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

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

Returns
Number

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

Sample

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

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

Returns
Number

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

Sample

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

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

Returns
Number

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

Sample

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

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

Returns
Number

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

Sample

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

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

Returns
Number

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

Sample

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

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

Returns
Number

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

Sample

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

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

Returns
Number

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

Sample

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

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

Returns
Number

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

Sample

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

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

Returns
Number

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

Sample

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

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

Returns
Number

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

Sample

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

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

Returns
Number

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

Sample

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


Unknown macro: {table}

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

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

Property Details

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

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

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

Returns
String

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

Sample

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

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

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

Returns
String

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

Sample

Unknown macro: {div}
var myForm = solutionModel.newForm('newForm', 'aServer', 'aTable', 'aStyleName', false, 800, 600)
	myForm.dataSource = 'db:/anotherServerName/anotherTableName'
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
defaultPageFormat
Unknown macro: {tr}
Unknown macro: {td}

The default page format for the form.

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

Returns
String

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

Sample

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

Replace with description

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

Returns
Number

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

Sample

Unknown macro: {div}
var myForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
myForm.encapsulation = JSForm.HIDE_CONTROLLER_ENCAPSULATION;
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
extendsForm
Unknown macro: {tr}
Unknown macro: {td}

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

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

Returns
JSForm

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

Sample

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

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

Returns
String

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('myForm','myServer','myTable',null,true,800,600);
form.initialSort = "column1 desc, column2 asc, column3 asc";
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
name
Unknown macro: {tr}
Unknown macro: {td}

The name of the form.

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

Returns
String

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('myForm','myServer','myTable',null,true,800,600);
var formName = form.name;
application.output(formName);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
namedFoundSet
Unknown macro: {tr}
Unknown macro: {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

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

Returns
String

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

Sample

Unknown macro: {div}
// 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';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
navigator
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSForm

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

Sample

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

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onDeleteRecordCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

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

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

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

Returns
JSMethod

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

Sample

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

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

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

Returns
JSMethod

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

Sample

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

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

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

Returns
JSMethod

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

Sample

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

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

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onDuplicateRecordCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

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

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

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

Returns
JSMethod

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

Sample

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

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

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onFindCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onHide
Unknown macro: {tr}
Unknown macro: {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).

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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; }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onInvertRecordsCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

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

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onNewRecordCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onNextRecordCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onOmitRecordCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onPreviousRecordCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onPrintPreviewCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
form.onPrintPreviewCmd = form.newFormMethod('function onPrintPreviewCmd(event) { application.output("onPrintPreviewCmd intercepted on " + event.getFormName()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onRecordEditStart
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onRecordEditStop
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onRecordSelection
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

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

The method that is executed when the component is rendered.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
form.onRender = form.newFormMethod('function onRender(event) { event.getElement().bgcolor = \'#00ff00\' }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onResize
Unknown macro: {tr}
Unknown macro: {td}

The method that gets triggered when resize occurs.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
form.onResize = form.newFormMethod('function onResize(event) { application.output("onResize intercepted on " + event.getFormName()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onSearchCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onShow
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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; }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onShowAllRecordsCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onShowOmittedRecordsCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onSortCmd
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
form.onSortCmd = form.newFormMethod('function onSortCmd(dataProviderID, asc, event) { application.output("onSortCmd intercepted on " + event.getFormName() + ". data provider: " + dataProviderID + ". asc: " + asc); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
onUnLoad
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
JSMethod

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

Sample

Unknown macro: {div}
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()); }');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
paperPrintScale
Unknown macro: {tr}
Unknown macro: {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%.

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

Returns
Number

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('myForm','myServer','myTable',null,true,800,600);
if (form.paperPrintScale < 100)
	form.paperPrintScale = 100;
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
scrollbars
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
Number

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('myForm','myServer','myTable',null,true,1000,600);
form.scrollbars = SM_SCROLLBAR.VERTICAL_SCROLLBAR_NEVER; 
forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
serverName
Unknown macro: {tr}
Unknown macro: {td}

Get the server name used by this form.

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

Returns
String

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('myForm','myServer','myTable',null,true,800,600);
form.serverName = 'anotherServerName';
var theServerName = form.getServerName();
application.output(theServerName);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
showInMenu
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
Boolean

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

Sample

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

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

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

Returns
String

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

Sample

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

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

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

Returns
String

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

Sample

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

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

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

Returns
String

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

Sample

Unknown macro: {div}
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()
	}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
titleText
Unknown macro: {tr}
Unknown macro: {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.

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

Returns
String

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

Sample

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

When set, the form is transparent.

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

Returns
Boolean

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

Sample

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

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

Returns
Number

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

Sample

Unknown macro: {div}
var myForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
myForm.view = JSForm.RECORD_VIEW;
forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
width
Unknown macro: {tr}
Unknown macro: {td}

The width of the form in pixels.

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

Returns
Number

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

Sample

Unknown macro: {div}
var myForm = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	forms['newForm1'].controller.show();
	myForm.width = 120;
 forms['newForm1'].controller.recreateUI();
Unknown macro: {tr}
Unknown macro: {td}


Unknown macro: {table}

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

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

Method Details

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

JSBean

Unknown macro: {span}

getBean

Unknown macro: {span}

(name)

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

Returns a JSBean that has the given name.

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

Parameters
{String} name – the specified name of the bean

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

Returns
JSBean – a JSBean object

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

Sample

Unknown macro: {div}
var btn = myForm.getBean("mybean");
application.output(mybean.className);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getBeans
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSBean[]

Unknown macro: {span}

getBeans

Unknown macro: {span}

()

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

Returns all JSBeans of this form.

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

Returns
JSBean[] – the list of all JSbuttons on this forms

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

Sample

Unknown macro: {div}
var beans = myForm.getBeans();
for (var b in beans)
{
		if (beans[b].name != null) 
			application.output(beans[b].name);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getBeans
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSBean[]

Unknown macro: {span}

getBeans

Unknown macro: {span}

(returnInheritedElements)

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

Returns all JSBeans of this form.

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

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

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

Returns
JSBean[] – the list of all JSbuttons on this forms

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

Sample

Unknown macro: {div}
var beans = myForm.getBeans();
for (var b in beans)
{
		if (beans[b].name != null) 
			application.output(beans[b].name);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getBodyPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

getBodyPart

Unknown macro: {span}

()

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

Retrieves the Body part of the form.

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

Returns
JSPart – A JSPart instance corresponding to the Body part of the form.

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

Sample

Unknown macro: {div}
form.getBodyPart().background = 'blue';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getButton
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSButton

Unknown macro: {span}

getButton

Unknown macro: {span}

(name)

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

Returns a JSButton that has the given name.

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

Parameters
{String} name – the specified name of the button

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

Returns
JSButton – a JSButton object

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

Sample

Unknown macro: {div}
var btn = myForm.getButton("hello");
application.output(btn.text);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getButtons
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSButton[]

Unknown macro: {span}

getButtons

Unknown macro: {span}

()

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

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

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

Returns
JSButton[] – the list of all JSbuttons on this forms

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

Sample

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

JSButton[]

Unknown macro: {span}

getButtons

Unknown macro: {span}

(returnInheritedElements)

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

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

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

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

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

Returns
JSButton[] – the list of all JSbuttons on this forms

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

Sample

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

JSComponent

Unknown macro: {span}

getComponent

Unknown macro: {span}

(name)

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

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

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

Parameters
{String} name – the specified name of the component

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

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

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var cmp = frm.getComponent("componentName");
	application.output("Component type and name: " + cmp);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getComponents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSComponent[]

Unknown macro: {span}

getComponents

Unknown macro: {span}

()

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

Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean or JSTabPanel.

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

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

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

Sample

Unknown macro: {div}
var form = solutionModel.getForm("myForm");
	var components = form.getComponents();
	for (var i in components)
		application.output("Component type and name: " + components[i]);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getComponents
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSComponent[]

Unknown macro: {span}

getComponents

Unknown macro: {span}

(returnInheritedElements)

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

Returns a array of all the JSComponents that a form has; they are of type JSField,JSLabel,JSButton,JSPortal,JSBean or JSTabPanel.

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

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

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

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

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

Sample

Unknown macro: {div}
var form = solutionModel.getForm("myForm");
	var components = form.getComponents();
	for (var i in components)
		application.output("Component type and name: " + components[i]);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getField
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

getField

Unknown macro: {span}

(name)

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

The field with the specified name.

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

Parameters
{String} name – the specified name of the field

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

Returns
JSField – a JSField object

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

Sample

Unknown macro: {div}
var form = solutionModel.getForm("myForm");
	var field = form.getField("myField");
	application.output(field.dataProviderID);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFields
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField[]

Unknown macro: {span}

getFields

Unknown macro: {span}

()

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

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

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

Returns
JSField[] – all JSField objects of this form

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

Sample

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

JSField[]

Unknown macro: {span}

getFields

Unknown macro: {span}

(returnInheritedElements)

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

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

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

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

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

Returns
JSField[] – all JSField objects of this form

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

Sample

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

JSPart

Unknown macro: {span}

getFooterPart

Unknown macro: {span}

()

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

Retrieves the Footer part of the form.

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

Returns
JSPart – A JSPart instance corresponding to the Footer part of the form.

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

Sample

Unknown macro: {div}
form.getFooterPart().background = 'magenta';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFormMethod
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMethod

Unknown macro: {span}

getFormMethod

Unknown macro: {span}

(name)

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

Gets an existing form method for the given name.

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

Parameters
{String} name – the specified name of the method

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

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

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var method = frm.getFormMethod("myMethod");
	application.output(method.code);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFormMethods
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMethod[]

Unknown macro: {span}

getFormMethods

Unknown macro: {span}

()

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

Returns all existing form methods for this form.

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

Returns
JSMethod[] – all form methods for the form

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var methods = frm.getFormMethods();
	for (var m in methods)
		application.output(methods[m].getName());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFormMethods
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMethod[]

Unknown macro: {span}

getFormMethods

Unknown macro: {span}

(returnInheritedElements)

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

Returns all existing form methods for this form.

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

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

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

Returns
JSMethod[] – all form methods for the form

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var methods = frm.getFormMethods();
	for (var m in methods)
		application.output(methods[m].getName());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFormVariable
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable

Unknown macro: {span}

getFormVariable

Unknown macro: {span}

(name)

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

Gets an existing form variable for the given name.

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

Parameters
{String} name – the specified name of the variable

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

Returns
JSVariable – a JSVariable object

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var fvariable = frm.getFormVariable("myVarName");
	application.output(fvariable.name + " has the default value of " + fvariable.defaultValue);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFormVariables
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable[]

Unknown macro: {span}

getFormVariables

Unknown macro: {span}

()

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

An array consisting of all form variables for this form.

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

Returns
JSVariable[] – an array of all variables on this form

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var variables = frm.getFormVariables();
	for (var i in variables)
		application.output(variables[i].name);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFormVariables
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable[]

Unknown macro: {span}

getFormVariables

Unknown macro: {span}

(returnInheritedElements)

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

An array consisting of all form variables for this form.

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

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

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

Returns
JSVariable[] – an array of all variables on this form

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var variables = frm.getFormVariables();
	for (var i in variables)
		application.output(variables[i].name);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getHeaderPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

getHeaderPart

Unknown macro: {span}

()

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

Retrieves the Header part of the form.

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

Returns
JSPart – A JSPart instance corresponding to the Header part of the form.

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

Sample

Unknown macro: {div}
form.getHeaderPart().background = 'orange';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getLabel
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSLabel

Unknown macro: {span}

getLabel

Unknown macro: {span}

(name)

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

Returns a JSLabel that has the given name.

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

Parameters
{String} name – the specified name of the label

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

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

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var label = frm.getLabel("myLabel");
	application.output(label.text);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getLabels
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSLabel[]

Unknown macro: {span}

getLabels

Unknown macro: {span}

()

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

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

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

Returns
JSLabel[] – all JSLabels on this form

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

Sample

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

JSLabel[]

Unknown macro: {span}

getLabels

Unknown macro: {span}

(returnInheritedElements)

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

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

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

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

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

Returns
JSLabel[] – all JSLabels on this form

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

Sample

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

JSPart

Unknown macro: {span}

getLeadingGrandSummaryPart

Unknown macro: {span}

()

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

Retrieves the Leading Grand Summary part of the form.

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

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

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

Sample

Unknown macro: {div}
form.getLeadingGrandSummaryPart().background = 'yellow';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getLeadingSubSummaryParts
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart[]

Unknown macro: {span}

getLeadingSubSummaryParts

Unknown macro: {span}

()

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

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

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

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

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

Sample

Unknown macro: {div}
form.getLeadingSubSummaryParts()[0].background = 'green';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

getPart

Unknown macro: {span}

(type)

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

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

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

Parameters
{Number} type – The type of the part to retrieve.

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

Returns
JSPart – A JSPart instance representing the retrieved form part.

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

Sample

Unknown macro: {div}
form.getPart(JSPart.HEADER).background = 'red';
form.getPart(JSPart.LEADING_SUBSUMMARY, 160).background = 'red';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

getPart

Unknown macro: {span}

(type, height)

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

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

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

Returns
JSPart – A JSPart instance representing the retrieved form part.

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

Sample

Unknown macro: {div}
form.getPart(JSPart.HEADER).background = 'red';
form.getPart(JSPart.LEADING_SUBSUMMARY, 160).background = 'red';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getPartYOffset
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getPartYOffset

Unknown macro: {span}

(type)

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

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

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

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

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

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

Sample

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

Number

Unknown macro: {span}

getPartYOffset

Unknown macro: {span}

(type, height)

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

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

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

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

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

Sample

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

JSPart[]

Unknown macro: {span}

getParts

Unknown macro: {span}

()

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

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

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

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

Sample

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

JSPart[]

Unknown macro: {span}

getParts

Unknown macro: {span}

(returnInheritedElements)

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

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

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

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

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

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

Sample

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

JSPortal

Unknown macro: {span}

getPortal

Unknown macro: {span}

(name)

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

Returns a JSPortal that has the given name.

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

Parameters
{String} name – the specified name of the portal

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

Returns
JSPortal – a JSPortal object

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var portal = frm.getPortal("myPortal");
 portal.initialSort = 'my_table_text desc';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getPortals
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPortal[]

Unknown macro: {span}

getPortals

Unknown macro: {span}

()

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

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

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

Returns
JSPortal[] – an array of all JSPortal objects on this form

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var portals = frm.getPortals();
	for (var i in portals)
	{
		var p = portals[i];
		if (p.name != null)
			application.output(p.name);
		else
			application.output("unnamed portal detected");
	}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getPortals
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPortal[]

Unknown macro: {span}

getPortals

Unknown macro: {span}

(returnInheritedElements)

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

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

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

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

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

Returns
JSPortal[] – an array of all JSPortal objects on this form

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var portals = frm.getPortals();
	for (var i in portals)
	{
		var p = portals[i];
		if (p.name != null)
			application.output(p.name);
		else
			application.output("unnamed portal detected");
	}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getTabPanel
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSTabPanel

Unknown macro: {span}

getTabPanel

Unknown macro: {span}

(name)

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

Returns a JSTabPanel that has the given name.

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

Parameters
{String} name – the specified name of the tabpanel

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

Returns
JSTabPanel – a JSTabPanel object

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var tabPanel = frm.getTabPanel("myTabPanel"); 
	var tabs = tabPanel.getTabs(); 
	for (var i=0; i<tabs.length; i++) 
		application.output("Tab " + i + " has text " + tabs[i].text);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getTabPanels
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSTabPanel[]

Unknown macro: {span}

getTabPanels

Unknown macro: {span}

()

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

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

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

Returns
JSTabPanel[] – an array of all JSTabPanel objects on this form

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

Sample

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

JSTabPanel[]

Unknown macro: {span}

getTabPanels

Unknown macro: {span}

(returnInheritedElements)

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

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

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

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

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

Returns
JSTabPanel[] – an array of all JSTabPanel objects on this form

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

Sample

Unknown macro: {div}
var frm = solutionModel.getForm("myForm");
	var tabPanels = frm.getTabPanels();
	for (var i in tabPanels)
	{
		var tp = tabPanels[i];
		if (tp.name != null)
			application.output("Tab " + tp.name + " has text " + tp.text);
		else
			application.output("Tab with text " + tp.text + " has no name");
	}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getTitleFooterPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

getTitleFooterPart

Unknown macro: {span}

()

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

Retrieves the Title Footer part of the form.

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

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

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

Sample

Unknown macro: {div}
form.getTitleFooterPart().background = 'gray';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getTitleHeaderPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

getTitleHeaderPart

Unknown macro: {span}

()

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

Retrieves the Title Header part of the form.

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

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

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

Sample

Unknown macro: {div}
form.getTitleHeaderPart().background = 'red';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getTrailingGrandSummaryPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

getTrailingGrandSummaryPart

Unknown macro: {span}

()

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

Retrieves the Trailing Grand Summary part of the form.

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

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

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

Sample

Unknown macro: {div}
form.getTrailingGrandSummaryPart().background = 'yellow';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getTrailingSubSummaryParts
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart[]

Unknown macro: {span}

getTrailingSubSummaryParts

Unknown macro: {span}

()

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

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

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

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

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

Sample

Unknown macro: {div}
form.getTrailingSubSummaryParts()[0].background = 'green';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getUUID
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

UUID

Unknown macro: {span}

getUUID

Unknown macro: {span}

()

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

Returns the UUID of this form.

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

Returns
UUID

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

Sample

Unknown macro: {div}
var form_UUID = myForm.getUUID();
application.output(form_UUID.toString());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newBean
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSBean

Unknown macro: {span}

newBean

Unknown macro: {span}

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

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

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.

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

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

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

Returns
JSBean – a JSBean object

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'server1', 'table1', null, true, 800, 600);
	var bean = form.newBean('bean','com.servoy.extensions.beans.dbtreeview.DBTreeView',200,200,300,300);
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newButton
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSButton

Unknown macro: {span}

newButton

Unknown macro: {span}

(text, x, y, width, height, jsmethod)

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

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

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

Parameters
text – the text on the button
{Number} x – the x coordinate of the button location on the form
{Number} y – the y coordinate of the button location on the form
{Number} width – the width of the button
{Number} height – the height of the button
jsmethod – the method assigned to handle an onAction event

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

Returns
JSButton – a new JSButton object

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var method = form.newFormMethod('function onAction(event) { application.output("onAction intercepted on " + event.getFormName()); }');
	var button = form.newButton('myButton', 10, 10, 100, 30, method);
	application.output("The new button: " + button.name + " has the following onAction event handling method assigned " + button.onAction.getName());
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newCalendar
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

newCalendar

Unknown macro: {span}

(dataprovidername/jsvariable, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
{Number} x – the horizontal "x" position of the JSfield object in pixels
{Number} y – the vertical "y" position of the JSField object in pixels
{Number} width – the width of the JSField object in pixels
{Number} height – the height of the JSField object in pixels

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

Returns
JSField – a new JSField object on the form with the displayType of CALENDAR

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var calendar = form.newCalendar(myDataProvider, 100, 100, 200, 200);
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newCheck
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

newCheck

Unknown macro: {span}

(dataprovidername/jsvariable, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
{Number} x – the horizontal "x" position of the JSfield object in pixels
{Number} y – the vertical "y" position of the JSField object in pixels
{Number} width – the width of the JSField object in pixels
{Number} height – the height of the JSField object in pixels

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

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

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var calendar = form.newCheck(myDataProvider, 100, 100, 200, 200);
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newComboBox
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

newComboBox

Unknown macro: {span}

(dataprovidername/jsvariable, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
{Number} x – the horizontal "x" position of the JSfield object in pixels
{Number} y – the vertical "y" position of the JSField object in pixels
{Number} width – the width of the JSField object in pixels
{Number} height – the height of the JSField object in pixels

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

Returns
JSField – a new JSField object on the form with the displayType of COMBOBOX

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var calendar = form.newComboBox(myDataProvider, 100, 100, 200, 200);
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newField
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

newField

Unknown macro: {span}

(dataprovidername/jsvariable, displaytype, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
displaytype – the display type of the JSField object (see the Solution Model -> JSField node for display types)
{Number} x – the horizontal "x" position of the JSField object in pixels
{Number} y – the vertical "y" position of the JSField object in pixels
{Number} width – the width of the JSField object in pixels
{Number} height – the height of the JSField object in pixels

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

Returns
JSField – a new JSField object (of the specified display type)

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var variable = form.newFormVariable('myVar', JSVariable.TEXT);
	variable.defaultValue = "'This is a default value (with tripple quotes)!'";
	var field = form.newField(variable, JSField.TEXT_FIELD, 100, 100, 200, 200);
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newFooterPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

newFooterPart

Unknown macro: {span}

()

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

Creates a new Footer part on the form.

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

Returns
JSPart – A JSPart instance corresponding to the newly created Footer form part.

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

Sample

Unknown macro: {div}
var footer = form.newFooterPart(440);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newFormMethod
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSMethod

Unknown macro: {span}

newFormMethod

Unknown macro: {span}

(code)

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

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

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

Parameters
{String} code – the specified code for the new method

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

Returns
JSMethod – a new JSMethod object for this form

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var method = form.newFormMethod('function aMethod(event){application.output("Hello world!");}');
	var button = myListViewForm.newButton('Show message!',50,50,100,30,method);
 forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newFormVariable
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSVariable

Unknown macro: {span}

newFormVariable

Unknown macro: {span}

(name, type)

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

Creates a new form JSVariable - based on the name of the variable object and the number type, uses the SolutionModel JSVariable constants.

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

Parameters
{String} name – the specified name of the variable
{Number} type – the specified type of the variable (see Solution Model -> JSVariable node constants)

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

Returns
JSVariable – a JSVariable object

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var variable = form.newFormVariable('myVar', JSVariable.TEXT);
	variable.defaultValue = "'This is a default value (with tripple quotes)!'";
	var field = form.newField(variable, JSField.TEXT_FIELD, 100, 100, 200, 200);
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newHeaderPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

newHeaderPart

Unknown macro: {span}

()

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

Creates a new Header part on the form.

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

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

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

Sample

Unknown macro: {div}
var header = form.newHeaderPart(80);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newHtmlArea
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

newHtmlArea

Unknown macro: {span}

(dataprovidername/jsvariable, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
{Number} x – the horizontal "x" position of the JSfield object in pixels
{Number} y – the vertical "y" position of the JSField object in pixels
{Number} width – the width of the JSField object in pixels
{Number} height – the height of the JSField object in pixels

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

Returns
JSField – a JSField object on the form with the displayType of HTML_AREA

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var textProvider = form.newFormVariable('myVar',JSVariable.TEXT);
	textProvider.defaultValue = "'This is a tripple quotted text!'";
	var htmlArea = myListViewForm.newHtmlArea(textProvider,100,100,100,100);
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newImageMedia
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

newImageMedia

Unknown macro: {span}

(dataprovidername/jsvariable, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
{Number} x – the horizontal "x" position of the JSfield object in pixels
{Number} y – the vertical "y" position of the JSField object in pixels
{Number} width – the width of the JSField object in pixels
{Number} height – the height of the JSField object in pixels

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

Returns
JSField – a new JSField object on the form with the displayType of IMAGE_MEDIA

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
 var myMediaVar = form.newFormVariable("media", JSVariable.MEDIA);
 var imageMedia = form.newImageMedia(myMediaVar,100,100,200,200)
 forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newLabel
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSLabel

Unknown macro: {span}

newLabel

Unknown macro: {span}

(txt, x, y, width, height)

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

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.

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

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

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

Returns
JSLabel – a JSLabel object

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var label = form.newLabel('The text on the label', 140, 140, 50, 20);
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newLabel
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSLabel

Unknown macro: {span}

newLabel

Unknown macro: {span}

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

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

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.

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

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

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

Returns
JSLabel – a JSLabel object

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var label = form.newLabel('The text on the label', 140, 140, 50, 20);
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newLeadingGrandSummaryPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

newLeadingGrandSummaryPart

Unknown macro: {span}

()

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

Creates a new Leading Grand Summary part on the form.

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

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

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

Sample

Unknown macro: {div}
var leadingGrandSummary = form.newLeadingGrandSummaryPart(120);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newLeadingSubSummaryPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

newLeadingSubSummaryPart

Unknown macro: {span}

()

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

Creates a new Leading Subsummary part on the form.

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

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

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

Sample

Unknown macro: {div}
var leadingSubsummary = form.newLeadingSubSummaryPart(160);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

newPart

Unknown macro: {span}

(type, height)

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

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

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

Parameters
{Number} type – The type of the new part.
{Number} height – The height of the new part

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

Returns
JSPart – A JSPart instance corresponding to the newly created form part.

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('myForm', 'example_data', 'my_table', null, false, 1200, 800);
var header = form.newPart(JSPart.HEADER, 100);
header.background = 'yellow';
var body = form.newPart(JSPart.BODY, 700);
body.background = 'green';
var footer = form.newPart(JSPart.FOOTER, 800);
footer.background = 'orange';
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newPassword
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

newPassword

Unknown macro: {span}

(dataprovidername/jsvariable, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
{Number} x – the horizontal "x" position of the JSfield object in pixels
{Number} y – the vertical "y" position of the JSField object in pixels
{Number} width – the width of the JSField object in pixels
{Number} height – the height of the JSField object in pixels

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

Returns
JSField – a new JSField object on the form with the displayType of PASSWORD

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
 var pass = form.newPassword(globals.aVariable, 100, 100, 70, 30);
 forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newPortal
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPortal

Unknown macro: {span}

newPortal

Unknown macro: {span}

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

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

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.

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

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

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

Returns
JSPortal – a JSPortal object

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'server1', 'table1', null, true, 800, 600);
	var relation = solutionModel.newRelation('parentToChild','server1','table1','server2','table2',JSRelation.INNER_JOIN);
	relation.newRelationItem('another_parent_table_id', '=', 'another_child_table_parent_id');
	var portal = form.newPortal('portal',relation,200,200,300,300);
	portal.newField('someColumn',JSField.TEXT_FIELD,200,200,120);
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newRadios
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

newRadios

Unknown macro: {span}

(dataprovidername/jsvariable, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
{Number} x – the horizontal "x" position of the JSfield object in pixels
{Number} y – the vertical "y" position of the JSField object in pixels
{Number} width – the width of the JSField object in pixels
{Number} height – the height of the JSField object in pixels

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

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

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1', 'myServer', 'myTable', null, true, 800, 600);
	var vlist = solutionModel.newValueList('options',JSValueList.CUSTOM_VALUES); 
	vlist.customValues = "value1\nvalue2\nvalue3"; 
	var radios = form.newRadios('columnDataProvider',100,100,200,200);
	radios.valuelist = vlist;
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newRtfArea
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

newRtfArea

Unknown macro: {span}

(dataprovidername/jsvariable, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
{Number} x – the horizontal "x" position of the JSfield object in pixels
{Number} y – the vertical "y" position of the JSField object in pixels
{Number} width – the width of the JSField object in pixels
{Number} height – the height of the JSField object in pixels

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

Returns
JSField – a JSField object with the displayType of RTF_AREA

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1','myServer','myTable',null,true,800,600);
	var rtf_area = form.newRtfArea('columnDataProvider',100,100,100,100);
 forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newTabPanel
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSTabPanel

Unknown macro: {span}

newTabPanel

Unknown macro: {span}

(name, x, y, width, height)

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

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.

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

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

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

Returns
JSTabPanel – a JSTabPanel object

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

Sample

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

JSField

Unknown macro: {span}

newTextArea

Unknown macro: {span}

(dataprovidername/jsvariable, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
{Number} x – the horizontal "x" position of the JSTabPanel object in pixels
{Number} y – the vertical "y" position of the JSTabPanel object in pixels
{Number} width – the width of the JSTabPanel object in pixels
{Number} height – the height of the JSTabPanel object in pixels

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

Returns
JSField – a JSField object with the displayType of TEXT_AREA

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1','myServer','myTable',null,true,800,600);
	var globalVar = solutionModel.newGlobalVariable('myGlobal',JSVariable.TEXT);
	globalVar.defaultValue = "'Type your text in here'";
	var textArea = form.newTextArea(globalVar,100,100,300,150);
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newTextField
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

newTextField

Unknown macro: {span}

(dataprovidername/jsvariable, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
{Number} x – the horizontal "x" position of the JSfield object in pixels
{Number} y – the vertical "y" position of the JSField object in pixels
{Number} width – the width of the JSField object in pixels
{Number} height – the height of the JSField object in pixels

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

Returns
JSField – a JSField object with the displayType of TEXT_FIELD

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1','myServer','myTable',null,true,800,600); 
	//choose the dataprovider or jsvariable you want for the Text Field
	var x = null;
	//global jsvariable as the dataprovider 
 //x = solutionModel.newGlobalVariable('myGlobal',JSVariable.TEXT);
	//x.defaultValue = "'Text from a global variable'";
	//or a form jsvariable as the dataprovider 
	//x = form.newFormVariable('myFormVar',JSVariable.TEXT);
	//x.defaultValue = "'Text from a form variable'";
	var textField = form.newTextField(x,100,100,200,50);
	//or a column data provider as the dataprovider
	//textField.dataProviderID = columnTextDataProvider;
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newTitleFooterPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

newTitleFooterPart

Unknown macro: {span}

()

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

Creates a new Title Footer part on the form.

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

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

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

Sample

Unknown macro: {div}
var titleFooter = form.newTitleFooterPart(500);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newTitleHeaderPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

newTitleHeaderPart

Unknown macro: {span}

()

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

Creates a new Title Header part on the form.

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

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

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

Sample

Unknown macro: {div}
var titleHeader = form.newTitleHeaderPart(40);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newTrailingGrandSummaryPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

newTrailingGrandSummaryPart

Unknown macro: {span}

()

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

Creates a new Trailing Grand Summary part on the form.

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

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

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

Sample

Unknown macro: {div}
var trailingGrandSummary = form.newTrailingGrandSummaryPart(400);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newTrailingSubSummaryPart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSPart

Unknown macro: {span}

newTrailingSubSummaryPart

Unknown macro: {span}

()

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

Creates a new Trailing Subsummary part on the form.

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

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

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

Sample

Unknown macro: {div}
var trailingSubsummary = form.newTrailingSubSummaryPart(360);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newTypeAhead
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSField

Unknown macro: {span}

newTypeAhead

Unknown macro: {span}

(dataprovidername/jsvariable, x, y, width, height)

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

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.

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

Parameters
dataprovidername/jsvariable – the specified dataprovider name/JSVariable of the JSField object
{Number} x – the horizontal "x" position of the JSfield object in pixels
{Number} y – the vertical "y" position of the JSField object in pixels
{Number} width – the width of the JSField object in pixels
{Number} height – the height of the JSField object in pixels

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

Returns
JSField – a JSField object with the displayType of TYPE_AHEAD

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newForm1','myServer','myTable',null,true,800,600);
	var vlist = solutionModel.newValueList('options',JSValueList.CUSTOM_VALUES);
	vlist.customValues = "value1\nvalue2\nvalue3";
	var typeAhead = form.newTypeAhead(columnTextDataProvider,100,100,300,200);
	typeAhead.valuelist = vlist;
	forms['newForm1'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeBean
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeBean

Unknown macro: {span}

(name)

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

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

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

Parameters
{String} name – the specified name of the JSBean to be removed

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

Returns
Boolean – true if the JSBean has been removed; false otherwise

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

Sample

Unknown macro: {div}
var form = solutionModel.getForm('myform');
 form.removeBean('mybean')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeButton
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeButton

Unknown macro: {span}

(name)

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

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

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

Parameters
{String} name – the specified name of the JSButton to be removed

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

Returns
Boolean – true if the JSButton has been removed; false otherwise

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newFormX','myServer','myTable',null,true,800,600);
 var b1 = form.newButton('This is button1',100,100,200,50,null);
 b1.name = 'b1';
 var jsmethod = form.newFormMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX'); if (form.removeButton('b1') == true) application.output('Button has been removed ok'); else application.output('Button could not be deleted'); forms['newFormX'].controller.recreateUI();}");
 var b2 = form.newButton('Click here to remove button1',100,230,200,50,jsmethod);
 b2.name = 'b2';
 forms['newFormX'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeComponent
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeComponent

Unknown macro: {span}

(name)

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

Removes a component (JSLabel, JSButton, JSField, JSPortal, JSBean, JSTabpanel) that has the given name. It is the same as calling "if(!removeLabel(name) && !removeButton(name) ....)".
Returns true if removal was successful, false otherwise.

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

Parameters
{String} name – the specified name of the component to be deleted

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

Returns
Boolean – true if component has been successfully deleted; false otherwise

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newFormX','myServer','parentTable',null,true,1000,750);
var jsbutton = form.newButton('JSButton to delete',100,100,200,50,null);
jsbutton.name = 'jsb';
var jslabel = form.newLabel('JSLabel to delete',100,200,200,50,null);
jslabel.name = 'jsl';
jslabel.transparent = false;
jslabel.background = 'green';
var jsfield = form.newField('globals.myGlobalVariable',JSField.TEXT_FIELD,100,300,200,50);
jsfield.name = 'jsf';
var relation = solutionModel.newRelation('parentToChild','myServer','parentTable','myServer','childTable',JSRelation.INNER_JOIN);
relation.newRelationItem('parent_table_id', '=', 'child_table_id');
var jsportal = form.newPortal('jsp',relation,100,400,300,300);
jsportal.newField('child_table_id',JSField.TEXT_FIELD,200,200,120);
var childOne = solutionModel.newForm('childOne','myServer','childTable',null,false,400,300);
childOne.newField('child_table_id', JSField.TEXT_FIELD,10,10,100,20);
var childTwo = solutionModel.newForm('childTwo','myServer','someOtherTable',null,false,400,300);
childTwo.newField('some_table_id', JSField.TEXT_FIELD,10,10,100,100); 
var jstabpanel = form.newTabPanel('jst',450,30,620,460);
jstabpanel.newTab('tab1','Child One',childOne,relation);
jstabpanel.newTab('tab2','Child Two',childTwo);
var jsmethod = form.newFormMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if ((form.removeComponent('jsb') == true) && (form.removeComponent('jsl') == true) && (form.removeComponent('jsf') == true) && (form.removeComponent('jsp') == true) & (form.removeComponent('jst') == true)) application.output('Components removed ok'); else application.output('Some component(s) could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var removerButton = form.newButton('Click here to remove form components',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeField
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeField

Unknown macro: {span}

(name)

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

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

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

Parameters
{String} name – the specified name of the JSField to remove

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

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

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newFormX','myServer','myTable',null,true,800,600);
var jsfield = form.newField(globals.myGlobalVariable,JSField.TEXT_FIELD,100,300,200,50);
jsfield.name = 'jsf';
var jsmethod = form.newFormMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if (form.removeComponent('jsf') == true) application.output('Field has been removed ok'); else application.output('Field could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var removerButton = form.newButton('Click here to remove the field',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeLabel
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeLabel

Unknown macro: {span}

(name)

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

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

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

Parameters
{String} name – the specified name of the JSLabel to be removed

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

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

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newFormX','myServer','myTable',null,true,1000,750);
var jslabel = form.newLabel('JSLabel to delete',100,200,200,50,null);
jslabel.name = 'jsl';
jslabel.transparent = false;
jslabel.background = 'green';
var jsmethod = form.newFormMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX'); if (form.removeComponent('jsl') == true) application.output('Label has been removed'); else application.output('Label could not be deleted'); forms['newFormX'].controller.recreateUI();}");
var removerButton = form.newButton('Click here to remove the green label',450,500,250,50,jsmethod);
removerButton.name = 'remover';
forms['newFormX'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removePart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removePart

Unknown macro: {span}

(type)

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

Removes a JSPart of the given type.

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

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

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

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

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

Sample

Unknown macro: {div}
form.removePart(JSPart.HEADER);
form.removePart(JSPart.LEADING_SUBSUMMARY, 160);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removePart
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removePart

Unknown macro: {span}

(type, height)

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

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

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

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

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

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

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

Sample

Unknown macro: {div}
form.removePart(JSPart.HEADER);
form.removePart(JSPart.LEADING_SUBSUMMARY, 160);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removePortal
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removePortal

Unknown macro: {span}

(name)

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

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

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

Parameters
{String} name – the specified name of the JSPortal to be removed

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

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

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

Sample

Unknown macro: {div}
var form = solutionModel.newForm('newFormX','myServer','myTable',null,true,800,600);
	var relation = solutionModel.newRelation('parentToChild','myServer','myTable','myServer','myOtherTable',JSRelation.INNER_JOIN);
	relation.newRelationItem('parent_table_id', '=', 'child_table_id');
	var jsportal = form.newPortal('jsp',relation,100,400,300,300);
	jsportal.newField('child_table_id',JSField.TEXT_FIELD,200,200,120);
	var jsmethod = form.newFormMethod("function removeMe(event) { var form = solutionModel.getForm('newFormX');\n if (form.removeComponent('jsp') == true) application.output('Portal removed ok'); else application.output('Portal could not be deleted'); forms['newFormX'].controller.recreateUI();}");
	var removerButton = form.newButton('Click here to remove the portal',450,500,250,50,jsmethod);
	removerButton.name = 'remover';
	forms['newFormX'].controller.show();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeTabPanel
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeTabPanel

Unknown macro: {span}

(name)

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

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

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

Parameters
{String} name – the specified name of the JSTabPanel to be removed

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

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

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

Sample

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