Versions Compared

Key

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


HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

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

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

Table Cell (td)
#onDeleteRecord
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)
#onDuplicateRecord
The method that overrides the Servoy menu item Select > Duplicate Record (or keyboard shortcut).
Table Body (tbody)
Table Row (tr)
Table Cell (td)

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

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

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

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

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

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

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

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

Table Cell (td)
#onShowAllRecords
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)
#onShowOmittedRecords
The method that overrides the Servoy menu item Select > Show Omitted Records.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

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

HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

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

Table Cell (td)
#onDrag
The method that is triggered when (non Design Mode) dragging occurs.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onDragEnd
The method that is triggered when (non Design Mode) dragging end occurs.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onDragOver
The method that is triggered when (non Design Mode) dragging over a component occurs.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onDrop
The method that is triggered when (non Design Mode) dropping occurs.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onElementFocusGained
The method that is triggered when focus is gained by a component inside the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onElementFocusLost
The method that gets triggered when focus is lost by a component inside the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#onHide
The method that is triggered when another form is being activated.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

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

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

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

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

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

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

HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#borderType
The type, color and style of border.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#dataSource
The names of the database server and table that this form is linked to.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#defaultPageFormat
The default page format for the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#encapsulation
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#extends
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#initialSort
The default sort order only when the form loads.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#name
The name of the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#namedFoundSet
Property that tells the form to use a named foundset instead of the default foundset.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#navigator
The navigator (previously named "controller")
that is used to control/navigate to the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#paperPrintScale
The percentage value the printed page is enlarged or reduced to; the size of the printed form
is inversely proportional.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#rowBGColorCalculation
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)
#scrollbars
Scrollbar options for the vertical and horizontal scrollbars.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#showInMenu
When set, the form is displayed under the Window menu.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#styleClass
The Cascading Style Sheet (CSS) class name applied to the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#styleName
The name of the Servoy style that is being used on the form.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#titleText
The text that displays in the title bar of the form window.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#transparent
When set, the form is transparent.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#view
The default form view mode.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#width
The width of the form in pixels.

HTML Table
idcommand
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

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

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

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

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

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

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

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

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

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

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

Table Body (tbody)
idonSearch
classnode
Table Row (tr)
idname
Table Cell (td)
onSearch
Table Row (tr)
iddes
Table Cell (td)
The method that overrides the Servoy menu item Select > Search (or keyboard shortcut) in Find mode.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{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
classnode
Table Row (tr)
idname
Table Cell (td)
onShowAllRecords
Table Row (tr)
iddes
Table Cell (td)
The method that overrides the Servoy menu item Select > Show All (or keyboard shortcut).
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{JSEvent} event – the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

Table Body (tbody)
idonSort
classnode
Table Row (tr)
idname
Table Cell (td)
onSort
Table Row (tr)
iddes
Table Cell (td)
The method that overrides the Servoy menu item Select > Sort.
This property is automatically set to "DEFAULT" (no override) when the form is created.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{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
classnode
Table Row (tr)
idname
Table Cell (td)
onDrag
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when (non Design Mode) dragging occurs.
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDragEnd
classnode
Table Row (tr)
idname
Table Cell (td)
onDragEnd
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when (non Design Mode) dragging end occurs.
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDragOver
classnode
Table Row (tr)
idname
Table Cell (td)
onDragOver
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when (non Design Mode) dragging over a component occurs.
Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDrop
classnode
Table Row (tr)
idname
Table Cell (td)
onDrop
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when (non Design Mode) dropping occurs.
Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

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

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

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

Table Body (tbody)
idonRecordEditStop
classnode
Table Row (tr)
idname
Table Cell (td)
onRecordEditStop
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when a record is being saved.
A record is saved when a user clicks out of it (for example on an empty part of the layout or to another form); can return false (for example as part of a validation) where a condition must be changed to return true.
NOTE: The name of this property has been changed from onRecordSave.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{JSEvent} event – the event that triggered the action
Table Row (tr)
idret
Table Cell (td)
Returns
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

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

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

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

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

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

Table Row (tr)
idprs
Table Cell (td)
Parameters
{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
classnode
Table Row (tr)
idname
Table Cell (td)
onUnLoad
Table Row (tr)
iddes
Table Cell (td)
The method that is triggered when a form is unloaded from the repository.
NOTE: Forms can be prevented from being removed from memory by referencing the form object in a global variable or inside an array inside a global variable. Do take care using this technique.
Forms take up memory and if too many forms are in memory and cannot be unloaded, there is a possibility of running out of memory.
Table Row (tr)
idprs
Table Cell (td)
Parameters
{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
classnode
Table Row (tr)
idname
Table Cell (td)
borderType
Table Row (tr)
iddes
Table Cell (td)
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
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

Table Body (tbody)
idencapsulation
classnode
Table Row (tr)
idname
Table Cell (td)
encapsulation
Table Row (tr)
iddes
Table Cell (td)
Replace with description
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idextends
classnode
Table Row (tr)
idname
Table Cell (td)
extends
Table Row (tr)
iddes
Table Cell (td)
Replace with description
Table Row (tr)
idret
Table Cell (td)
Returns
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

Table Body (tbody)
idnamedFoundSet
classnode
Table Row (tr)
idname
Table Cell (td)
namedFoundSet
Table Row (tr)
iddes
Table Cell (td)
Property that tells the form to use a named foundset instead of the default foundset.
When "separate" as special value is specified the form will always create a copy of assigned foundset and therefor become separated from other foundsets
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

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

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

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

Table Body (tbody)
idrowBGColorCalculation
classnode
Table Row (tr)
idname
Table Cell (td)
rowBGColorCalculation
Table Row (tr)
iddes
Table Cell (td)
The calculation dataprovider used to add background color and highlight selected or alternate rows.
The default is -none-.
Table Row (tr)
idret
Table Cell (td)
Returns
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

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

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

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

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

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

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

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

The default form view mode.

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

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

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

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