Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Rev: 1381948887907

...

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Command Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onDeleteAllRecordsonDeleteAllRecords
The method that overrides the Servoy menu item Select > Delete All.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onDeleteRecordonDeleteRecord
The method that overrides the Servoy menu item Select > Delete Record (or keyboard shortcut).
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onDuplicateRecordonDuplicateRecord
The method that overrides the Servoy menu item Select > Duplicate Record (or keyboard shortcut).
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)

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

Table Cell (td)
#onInvertRecordsonInvertRecords
The method that overrides the Servoy menu item Select > Invert Records.
tbody
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onNewRecordonNewRecord
The method that overrides the Servoy menu item Select > New Record (or keyboard shortcut).
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onNextRecordonNextRecord
The method that overrides the Servoy menu item Select > Next Record.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onOmitRecordonOmitRecord
The method that overrides the Servoy menu item Select > Omit Record.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onPreviousRecordonPreviousRecord
The method that overrides the Servoy menu item Select > Previous Record.
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onPrintPreviewonPrintPreview
The method that overrides the Servoy menu item File > Print Preview.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)

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

Table Cell (td)
#onShowAllRecordsonShowAllRecords
The method that overrides the Servoy menu item Select > Show All (or keyboard shortcut).
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onShowOmittedRecordsonShowOmittedRecords
The method that overrides the Servoy menu item Select > Show Omitted Records.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

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

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

tbody
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Event Summary
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#onDragonDrag
The method that is triggered when (non Design Mode) dragging occurs.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onDragEndonDragEnd
The method that is triggered when (non Design Mode) dragging end occurs.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onDragOveronDragOver
The method that is triggered when (non Design Mode) dragging over a component occurs.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onDroponDrop
The method that is triggered when (non Design Mode) dropping occurs.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onElementFocusGainedonElementFocusGained
The method that is triggered when focus is gained by a component inside the form.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onElementFocusLostonElementFocusLost
The method that gets triggered when focus is lost by a component inside the form.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onHideonHide
The method that is triggered when another form is being activated.
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onLoadonLoad
The method that is triggered when a form is loaded/reloaded from the repository; used to alter elements, set globals, hide toolbars,
etc; onShow method can also be assigned.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onRecordEditStartonRecordEditStart
The method that is triggered when a user clicks into a column on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onRecordEditStoponRecordEditStop
The method that is triggered when a record is being saved.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onRecordSelectiononRecordSelection
The method that is triggered each time a record is selected.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onRenderonRender
The method that is executed when the component is rendered.
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onResizeonResize
The method that gets triggered when resize occurs.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onShowonShow
The method that is triggered EVERY TIME the form is displayed; an argument must be passed to the method if this is the first time the form is displayed.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

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

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#borderTypeborderType
The type, color and style of border.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#dataSourcedataSource
The names of the database server and table that this form is linked to.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#defaultPageFormatdefaultPageFormat
The default page format for the form.
Table Row (tr)
Table Cell (td)
NumberString
Table Cell (td)
#encapsulation
The encapsulation mode for the form (see JSForm constants for encapsulation mode constants).
Table Body (tbody)
deprecated
Gets the deprecate info for this element
Table Row (tr)
Table Cell (td)
NumberObject
Table Cell (td)
#extendsForm
The selected parent designTimeProperties
Property to get and add design-time properties for a component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
encapsulation
The encapsulation mode of this persist.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
extendsForm
The selected parent (extended element) for the element (form).
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#initialSortinitialSort
The default sort order only when the form loads.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#namename
The name of the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#namedFoundSetnamedFoundSet
Property that tells the form to use a named foundset instead of the default foundset.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#navigatornavigator
The navigator (previously named "controller")
that is used to control/navigate to the form.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#paperPrintScalepaperPrintScale
The percentage value the printed page is enlarged or reduced to; the size of the printed form
is inversely proportional.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#rowBGColorCalculationrowBGColorCalculation
The calculation dataprovider used to add background color and highlight selected or alternate rows.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#scrollbarsscrollbars
Scrollbar options for the vertical and horizontal scrollbars.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#selectionModeselectionMode
Returns the value of the selectionMode property.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#showInMenushowInMenu
When set, the form is displayed under the Window menu.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#styleClassstyleClass
The Cascading Style Sheet (CSS) class name applied to the form.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#styleNamestyleName
The name of the Servoy style that is being used on the form.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#titleTexttitleText
The text that displays in the title bar of the form window.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#transparenttransparent
When set, the form is transparent.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#viewview
The default form view mode.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#widthwidth
The width of the form in pixels.

HTML Table
idcommand
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Command Details
Table Body (tbody)
idonDeleteAllRecords-JSEvent
Table Row (tr)
idname
Table Cell (td)
onDeleteAllRecords
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Delete All.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDeleteRecord-JSEvent
Table Row (tr)
idname
Table Cell (td)
onDeleteRecord
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Delete Record (or keyboard shortcut).
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDuplicateRecord-JSEvent
Table Row (tr)
idname
Table Cell (td)
onDuplicateRecord
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Duplicate Record (or keyboard shortcut).
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonFind-JSEvent
Table Row (tr)
idname
Table Cell (td)
onFind
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Find (or keyboard shortcut) in Data (ready) mode.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonInvertRecords-JSEvent
Table Row (tr)
idname
Table Cell (td)
onInvertRecords
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Invert Records.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonNewRecord-JSEvent
Table Row (tr)
idname
Table Cell (td)
onNewRecord
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > New Record (or keyboard shortcut).
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonNextRecord-JSEvent
Table Row (tr)
idname
Table Cell (td)
onNextRecord
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Next Record.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonOmitRecord-JSEvent
Table Row (tr)
idname
Table Cell (td)
onOmitRecord
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Omit Record.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonPreviousRecord-JSEvent
Table Row (tr)
idname
Table Cell (td)
onPreviousRecord
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Previous Record.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonPrintPreview-JSEvent
Table Row (tr)
idname
Table Cell (td)
onPrintPreview
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item File > Print Preview.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonSearch-Boolean_Boolean_JSEvent
Table Row (tr)
idname
Table Cell (td)
onSearch
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Search (or keyboard shortcut) in Find mode.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{Boolean} clear - clear last results
{Boolean} reduce - reduce search
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonShowAllRecords-JSEvent
Table Row (tr)
idname
Table Cell (td)
onShowAllRecords
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Show All (or keyboard shortcut).
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonShowOmittedRecords-JSEvent
Table Row (tr)
idname
Table Cell (td)
onShowOmittedRecords
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Show Omitted Records.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonSort-String_Boolean_JSEvent
Table Row (tr)
idname
Table Cell (td)
onSort
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that overrides the Servoy menu item Select > Sort.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} dataProviderID - element data provider
{Boolean} asc - sort ascending [true] or descending [false]
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idevent
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Event Details
Table Body (tbody)
idonDrag-JSDNDEvent
Table Row (tr)
idname
Table Cell (td)
onDrag
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when (non Design Mode) dragging occurs.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSDNDEvent} event - the event that triggered the action
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDragEnd-JSDNDEvent
Table Row (tr)
idname
Table Cell (td)
onDragEnd
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when (non Design Mode) dragging end occurs.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSDNDEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDragOver-JSDNDEvent
Table Row (tr)
idname
Table Cell (td)
onDragOver
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when (non Design Mode) dragging over a component occurs.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSDNDEvent} event - the event that triggered the action
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDrop-JSDNDEvent
Table Row (tr)
idname
Table Cell (td)
onDrop
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when (non Design Mode) dropping occurs.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSDNDEvent} event - the event that triggered the action
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonElementFocusGained-JSEvent
Table Row (tr)
idname
Table Cell (td)
onElementFocusGained
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when focus is gained by a component inside the form.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonElementFocusLost-JSEvent
Table Row (tr)
idname
Table Cell (td)
onElementFocusLost
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that gets triggered when focus is lost by a component inside the form.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonHide-JSEvent
Table Row (tr)
idname
Table Cell (td)
onHide
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when another form is being activated.
NOTE: If the onHide method returns false, the form can be prevented from hiding.
For example, when using onHide with showFormInDialog, the form will not close by clicking the dialog close box (X).
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

Table Body (tbody)
idonRecordEditStart-JSEvent
Table Row (tr)
idname
Table Cell (td)
onRecordEditStart
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when a user clicks into a column on the form.
NOTE: There is a small "e" displayed in the lower left side of the Servoy Client screen in the status area at the bottom of the window when the record is being edited.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonRecordEditStop-JSRecord_JSEvent
Table Row (tr)
idname
Table Cell (td)
onRecordEditStop
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when a record is being saved.
A record is saved when a user clicks out of it (for example on an empty part of the layout or to another form).
When the method returns false (for example as part of a validation), the user cannot leave the record, for example in
a table view a user cannot move to another record when the callback returns false.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSRecord} record - record being saved
{JSEvent} event - the event that triggered the action
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

Table Body (tbody)
idonRender-JSRenderEvent
Table Row (tr)
idname
Table Cell (td)
onRender
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component is rendered.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSRenderEvent} event - the render event
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonResize-JSEvent
Table Row (tr)
idname
Table Cell (td)
onResize
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that gets triggered when resize occurs.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonShow-Boolean_JSEvent
Table Row (tr)
idname
Table Cell (td)
onShow
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

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

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

Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{Boolean} firstShow - form is shown first time after load
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonUnLoad-JSEvent
Table Row (tr)
idname
Table Cell (td)
onUnLoad
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is triggered when a form is unloaded from the repository.
NOTE: Forms can be prevented from being removed from memory by referencing the form object in a global variable or inside an array inside a global variable. Do take care using this technique.
Forms take up memory and if too many forms are in memory and cannot be unloaded, there is a possibility of running out of memory.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details
Table Body (tbody)
idborderType
Table Row (tr)
idname
Table Cell (td)
borderType
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The type, color and style of border.
This property is automatically set to "DEFAULT" when a new form is created.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddataSource
Table Row (tr)
idname
Table Cell (td)
dataSource
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The names of the database server and table that this form is linked to.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddefaultPageFormat
Table Row (tr)
idname
Table Cell (td)
defaultPageFormat
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The default page format for the form.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idencapsulationdeprecated
Table Row (tr)
idname
Table Cell (td)
deprecated
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Table Cell (td)
encapsulation
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The encapsulation mode for the form (see JSForm constants for encapsulation mode constants).Gets the deprecate info for this element
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String - the deprecate info for this element or null if it is not deprecated
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddesignTimeProperties
Table Row (tr)
idname
Table Cell (td)
designTimeProperties
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Property to get and add design-time properties for a component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Object - map of the design-time properties
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idencapsulation
Table Row (tr)
idname
Table Cell (td)
encapsulation
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

The encapsulation mode of this persist. The following can be used/checked:

- Public (not a separate option - if none of the below options are selected)
- Hide in scripting; Module Scope - not available in scripting from any other context except the form itself. Available in designer for the same module.
- Module Scope - available in both scripting and designer but only in the same module.
- Hide Dataproviders (checked by default)
- Hide Foundset (checked by default)
- Hide Controller (checked by default)
- Hide Elements (checked by default)

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number - the encapsulation mode/level for of the formpersist.
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idextendsForm
Table Row (tr)
idname
Table Cell (td)
extendsForm
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The selected parent (extended element) for the element (form).
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number - the parent
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idinitialSort
Table Row (tr)
idname
Table Cell (td)
initialSort
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The default sort order only when the form loads.
This is applied each time an internal SQL query is being executed (find, find-all, open form); and is only executed when no other manual sort has been performed on the foundset.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idname
Table Row (tr)
idname
Table Cell (td)
name
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the form.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idnamedFoundSet
Table Row (tr)
idname
Table Cell (td)
namedFoundSet
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
When "empty" it will initially load an empty foundset.
When a global relation name it will load the a related foundset.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

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

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idpaperPrintScale
Table Row (tr)
idname
Table Cell (td)
paperPrintScale
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The percentage value the printed page is enlarged or reduced to; the size of the printed form
is inversely proportional. For example, if the paperPrintScale is 50, the printed form will be
enlarged 200%.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idrowBGColorCalculation
Table Row (tr)
idname
Table Cell (td)
rowBGColorCalculation
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

The calculation dataprovider used to add background color and highlight selected or alternate rows.
The default is -none-.

NOTE: This property has been deprecated and is kept visible for legacy purposes. Use CSS Row Styling & onRender event instead.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idscrollbars
Table Row (tr)
idname
Table Cell (td)
scrollbars
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Scrollbar options for the vertical and horizontal scrollbars. Each of the
vertical and horizontal scrollbars can be configured to display all the time,
to display only when needed or to never display.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idselectionMode
Table Row (tr)
idname
Table Cell (td)
selectionMode
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the value of the selectionMode property.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number - one of IForm#SELECTION_MODE_DEFAULT, IForm#SELECTION_MODE_SINGLE and IForm#SELECTION_MODE_MULTI.
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idshowInMenu
Table Row (tr)
idname
Table Cell (td)
showInMenu
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
When set, the form is displayed under the Window menu.
If it is not set, the form will be 'hidden'.
NOTE: This is only applicable for Servoy Client. Servoy Developer always shows all forms so that
developers have access to all forms within a solution during development.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idstyleClass
Table Row (tr)
idname
Table Cell (td)
styleClass
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The Cascading Style Sheet (CSS) class name applied to the form.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idstyleName
Table Row (tr)
idname
Table Cell (td)
styleName
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the Servoy style that is being used on the form.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtitleText
Table Row (tr)
idname
Table Cell (td)
titleText
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The text that displays in the title bar of the form window.
NOTE: Data tags and Servoy tags can be used as part of the title text.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtransparent
Table Row (tr)
idname
Table Cell (td)
transparent
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
When set, the form is transparent.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

The default form view mode.

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

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

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idwidth
Table Row (tr)
idname
Table Cell (td)
width
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The width of the form in pixels.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)