Page History

Divcache

Div

id	description

HTML Table

id

class

servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Command Summary

Table Row (tr)

Table Cell (td)

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

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 Row (tr)

Table Cell (td)

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

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 Row (tr)

Table Cell (td)

Table Cell (td)
onInvertRecords The method that overrides the Servoy menu item Select > Invert Records.

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 Row (tr)

Table Cell (td)

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

Table Row (tr)

Table Cell (td)

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

Table Row (tr)

Table Cell (td)

Table Cell (td)onPreviousRecord

indexstyle	true	display:none

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

refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Property SummaryThe type, color and style of border.The names of the database server and table that this form is linked to.The default page format for the form.Gets the deprecate info for this elementProperty to get and add design-time properties for a component.The encapsulation mode of this persist.The selected parent (extended element) for the element (form).The default sort order only when the form loads.The name of the form.Property that tells the form to use a named foundset instead of the default foundset.The navigator (previously named "controller") that is used to control/navigate to the form.The percentage value the printed page is enlarged or reduced to; the size of the printed form is inversely proportional.The calculation dataprovider used to add background color and highlight selected or alternate rows.Scrollbar options for the vertical and horizontal scrollbars.Returns the value of the selectionMode property.When set, the form is displayed under the Window menu.The Cascading Style Sheet (CSS) class name applied to the form.The name of the Servoy style that is being used on the form.The text that displays in the title bar of the form window.When set, the form is transparent.The default form view mode.The width of the form in pixels.

servoy sSummary12%30%58%height: 30px;3Command SummaryvoidThe method that overrides the Servoy menu item Select > Previous Record. Table Row (tr)

Table Cell (td)

Table Cell (td)onPrintPreview

Delete All.

void

The method that overrides the Servoy menu item

File > Print Preview. Table Row (tr)

Table Cell (td)

Table Cell (td)onSearch

Select > Delete Record (or keyboard shortcut).

void

The method that overrides the Servoy menu item Select >

Search

Duplicate Record (or keyboard shortcut)

in Find mode. Table Row (tr)

Table Cell (td)

Table Cell (td)onShowAllRecords

.

void

The method that overrides the Servoy menu item Select >

Show All

Find (or keyboard shortcut)

. Table Row (tr)

Table Cell (td)

Table Cell (td)onShowOmittedRecords

in Data (ready) mode.

void

The method that overrides the Servoy menu item Select >

Show Omitted Table Row (tr)

Table Cell (td)

Table Cell (td)onSort

Invert Records.

void

The method that overrides the Servoy menu item Select >

Sort. HTML Tableidclassservoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Event Summary

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)

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

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 Row (tr)

Table Cell (td)
Boolean

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

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 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 Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
onHide The method that is triggered when another form is being activated.

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 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 Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)

Table Cell (td)
onRecordSelection The method that is triggered each time a record is selected.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onRender The method that is executed when the component is rendered.

Table Row (tr)

Table Cell (td)

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

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 Row (tr)

Table Cell (td)

Table Cell (td)onUnLoad

New Record (or keyboard shortcut).

void

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

void

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

void

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

void

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

void

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

void

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

void

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

void

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

servoy sSummary12%30%58%height: 30px;3Event SummaryThe method that is triggered when (non Design Mode) dragging occurs.voidThe method that is triggered when (non Design Mode) dragging end occurs.The method that is triggered when (non Design Mode) dragging over a component occurs.The method that is triggered when (non Design Mode) dropping occurs.Method that is executed when the data in one of the form's component is successfully changed and the onDataChange callback from the component does not exist or exists and returned trueThe method that is triggered when focus is gained by a component inside the form.The method that gets triggered when focus is lost by a component inside the form.The method that is triggered when another form is being activated.voidThe method that is triggered when a form is unloaded loaded/reloaded from the repository. HTML Tableidclassservoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
dataSource The names of the database server and table that this form is linked to.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
defaultPageFormat The default page format for the form.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
deprecated Gets the deprecate info for this element

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
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).

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
rowBGColorCalculation The calculation dataprovider used to add background color and highlight selected or alternate rows.

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
String

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

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

HTML Table

id	command
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Command Details

Table Body (tbody)

id	onDeleteAllRecords-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onDeleteAllRecords

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDeleteRecord-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onDeleteRecord

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDuplicateRecord-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onDuplicateRecord

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onFind-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onFind

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onInvertRecords-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onInvertRecords

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onNewRecord-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onNewRecord

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onNextRecord-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onNextRecord

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onOmitRecord-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onOmitRecord

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onPreviousRecord-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onPreviousRecord

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onPrintPreview-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onPrintPreview

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onSearch-Boolean_Boolean_JSEvent

Table Row (tr)

id	name

Table Cell (td)
onSearch

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} clear - clear last results
{Boolean} reduce - reduce search
{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onShowAllRecords-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onShowAllRecords

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onShowOmittedRecords-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onShowOmittedRecords

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onSort-String_Boolean_JSEvent

Table Row (tr)

id	name

Table Cell (td)
onSort

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} dataProviderID - element data provider
{Boolean} asc - sort ascending [true] or descending [false]
{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	event
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Event Details

Table Body (tbody)

id	onDrag-JSDNDEvent

Table Row (tr)

id	name

Table Cell (td)
onDrag

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSDNDEvent} event - the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDragEnd-JSDNDEvent

Table Row (tr)

id	name

Table Cell (td)
onDragEnd

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSDNDEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDragOver-JSDNDEvent

Table Row (tr)

id	name

Table Cell (td)
onDragOver

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSDNDEvent} event - the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDrop-JSDNDEvent

Table Row (tr)

id	name

Table Cell (td)
onDrop

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSDNDEvent} event - the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onElementFocusGained-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onElementFocusGained

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onElementFocusLost-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onElementFocusLost

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onHide-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onHide

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered when another form is being activated.
NOTE: If the onHide method returns false, the form can be prevented from hiding.
For example, when using onHide with showFormInDialog, the form will not close by clicking the dialog close box (X).

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onLoad-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onLoad

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRecordEditStart-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onRecordEditStart

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRecordEditStop-JSRecord_JSEvent

Table Row (tr)

id	name

Table Cell (td)
onRecordEditStop

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSRecord} record - record being saved
{JSEvent} event - the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRecordSelection-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onRecordSelection

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is triggered each time a record is selected.
If a form is in List view or Special table view - when the user clicks on it.
In Record view - after the user navigates to another record using the slider or clicks up or down for next/previous record.
NOTE: Data and Servoy tag values are returned when the onRecordSelection method is executed.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRender-JSRenderEvent

Table Row (tr)

id	name

Table Cell (td)
onRender

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is rendered.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSRenderEvent} event - the render event

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onResize-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onResize

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that gets triggered when resize occurs.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onShow-Boolean_JSEvent

Table Row (tr)

id	name

Table Cell (td)
onShow

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

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

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Boolean} firstShow - form is shown first time after load
{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onUnLoad-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onUnLoad

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id	borderType

Table Row (tr)

id	name

Table Cell (td)
borderType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The type, color and style of border.
This property is automatically set to "DEFAULT" when a new form is created.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	dataSource

Table Row (tr)

id	name

Table Cell (td)
dataSource

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	defaultPageFormat

Table Row (tr)

id	name

Table Cell (td)
defaultPageFormat

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The default page format for the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	deprecated

Table Row (tr)

id	name

Table Cell (td)
deprecated

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the deprecate info for this element

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the deprecate info for this element or null if it is not deprecated

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	designTimeProperties

Table Row (tr)

id	name

Table Cell (td)
designTimeProperties

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Property to get and add design-time properties for a component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object - map of the design-time properties

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	encapsulation

Table Row (tr)

id	name

Table Cell (td)
encapsulation

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - the encapsulation mode/level of the persist.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	extendsForm

Table Row (tr)

id	name

Table Cell (td)
extendsForm

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The selected parent (extended element) for the element (form).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - the parent

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	initialSort

Table Row (tr)

id	name

Table Cell (td)
initialSort

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the form.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	namedFoundSet

Table Row (tr)

id	name

Table Cell (td)
namedFoundSet

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Property that tells the form to use a named foundset instead of the default foundset.
When "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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	navigator

Table Row (tr)

id	name

Table Cell (td)
navigator

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	paperPrintScale

Table Row (tr)

id	name

Table Cell (td)
paperPrintScale

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	rowBGColorCalculation

Table Row (tr)

id	name

Table Cell (td)
rowBGColorCalculation

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	scrollbars

Table Row (tr)

id	name

Table Cell (td)
scrollbars

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	selectionMode

Table Row (tr)

id	name

Table Cell (td)
selectionMode

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the value of the selectionMode property.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - one of IForm#SELECTION_MODE_DEFAULT, IForm#SELECTION_MODE_SINGLE and IForm#SELECTION_MODE_MULTI.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	showInMenu

Table Row (tr)

id	name

Table Cell (td)
showInMenu

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	styleClass

Table Row (tr)

id	name

Table Cell (td)
styleClass

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	styleName

Table Row (tr)

id	name

Table Cell (td)
styleName

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	titleText

Table Row (tr)

id	name

Table Cell (td)
titleText

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	transparent

Table Row (tr)

id	name

Table Cell (td)
transparent

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

When set, the form is transparent.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	view

Table Row (tr)

id	name

Table Cell (td)
view

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The default form view mode.

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

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	width

Table Row (tr)

id	name

Table Cell (td)
width

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The width of the form in pixels.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

; used to alter elements, set globals, hide toolbars, etc; onShow method can also be assigned.

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

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

void

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

void

The method that is executed when the component is rendered.

void

The method that gets triggered when resize occurs.

void

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.

void

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

propertyservoy sDetail2100%height:30px2Property DetailsborderTypename

borderType

des

sIndent

The type, color and style of border.
This property is automatically set to "DEFAULT" when a new form is created.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

dataSource

name

dataSource

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

defaultPageFormat

name

defaultPageFormat

des

sIndent

The default page format for the form.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient

sam

Sample

sIdent

javascript

lastDetailRow

deprecated

name

deprecated

des

sIndent

Gets the deprecate info for this element

ret

Returns

sIndent

the deprecate info for this element or null if it is not deprecated

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

designTimeProperties

name

designTimeProperties

des

sIndent

Property to get and add design-time properties for a component.

ret

Returns

sIndent

map of the design-time properties

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

encapsulation

name

encapsulation

des

sIndent

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)

ret

Returns

sIndent

the encapsulation mode/level of the persist.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

extendsForm

name

extendsForm

des

sIndent

The selected parent (extended element) for the element (form).

ret

Returns

sIndent

the parent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

formComponent

name

formComponent

des

sIndent

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

initialSort

name

initialSort

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

name

des

sIndent

The name of the form.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

namedFoundSet

name

namedFoundSet

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

navigator

name

navigator

des

sIndent

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

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

paperPrintScale

name

paperPrintScale

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient

sam

Sample

sIdent

javascript

lastDetailRow

rowBGColorCalculation

name

rowBGColorCalculation

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

scrollbars

name

scrollbars

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

selectionMode

name

selectionMode

des

sIndent

Returns the value of the selectionMode property.

ret

Returns

sIndent

one of IForm#SELECTION_MODE_DEFAULT, IForm#SELECTION_MODE_SINGLE and IForm#SELECTION_MODE_MULTI.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

showInMenu

name

showInMenu

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

styleClass

name

styleClass

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

styleName

name

styleName

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient

sam

Sample

sIdent

javascript

lastDetailRow

titleText

name

titleText

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

transparent

name

transparent

des

sIndent

When set, the form is transparent.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

view

name

view

des

sIndent

The default form view mode.

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

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

width

name

width

des

sIndent

The width of the form in pixels.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

commandservoy sDetail2100%height:30px2Command DetailsonDeleteAllRecordsname

onDeleteAllRecords

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onDeleteRecord

name

onDeleteRecord

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onDuplicateRecord

name

onDuplicateRecord

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onFind

name

onFind

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onInvertRecords

name

onInvertRecords

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onNewRecord

name

onNewRecord

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onNextRecord

name

onNextRecord

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onOmitRecord

name

onOmitRecord

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onPreviousRecord

name

onPreviousRecord

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onPrintPreview

name

onPrintPreview

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient,WebClient

sam

Sample

sIdent

javascript

lastDetailRow

onSearch

name

onSearch

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onShowAllRecords

name

onShowAllRecords

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onShowOmittedRecords

name

onShowOmittedRecords

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient

sam

Sample

sIdent

javascript

lastDetailRow

onSort

name

onSort

des

sIndent

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

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

eventservoy sDetail2100%height:30px2Event DetailsonDragname

onDrag(event)

des

sIndent

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

prs

Parameters

sIndent

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient

sam

Sample

sIdent

javascript

lastDetailRow

onDragEnd

name

onDragEnd(event)

des

sIndent

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

prs

Parameters

sIndent

event

the event that triggered the action

clients

Supported Clients

sIndent

SmartClient,WebClient

sam

Sample

sIdent

javascript

lastDetailRow

onDragOver

name

onDragOver(event)

des

sIndent

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

prs

Parameters

sIndent

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient

sam

Sample

sIdent

javascript

lastDetailRow

onDrop

name

onDrop(event)

des

sIndent

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

prs

Parameters

sIndent

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient

sam

Sample

sIdent

javascript

lastDetailRow

onElementDataChange

name

onElementDataChange(oldValue, newValue, event)

des

sIndent

Method that is executed when the data in one of the form's component is successfully changed and
the onDataChange callback from the component does not exist or exists and returned true

prs

Parameters

sIndent

oldValue

old value

newValue

new value

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

onElementFocusGained

name

onElementFocusGained(event)

des

sIndent

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

prs

Parameters

sIndent

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

onElementFocusLost

name

onElementFocusLost(event)

des

sIndent

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

prs

Parameters

sIndent

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

onHide

name

onHide(event)

des

sIndent

The method that is triggered when another form is being activated.
NOTE: If the onHide method returns false, the form can be prevented from hiding.
For example, when using onHide with showFormInDialog, the form will not close by clicking the dialog close box (X).

prs

Parameters

sIndent

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

onLoad

name

onLoad(event)

des

sIndent

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

prs

Parameters

sIndent

event

the event that triggered the action

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

onRecordEditStart

name

onRecordEditStart(event)

des

sIndent

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

prs

Parameters

sIndent

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

onRecordEditStop

name

onRecordEditStop(record, event)

des

sIndent

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

prs

Parameters

sIndent

record

record being saved

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

onRecordSelection

name

onRecordSelection(event)

des

sIndent

The method that is triggered each time a record is selected.
If a form is in List view or Special table view - when the user clicks on it.
In Record view - after the user navigates to another record using the slider or clicks up or down for next/previous record.
NOTE: Data and Servoy tag values are returned when the onRecordSelection method is executed.
NOTE: this will also fire if the selection goes to -1 because the foundset is cleared. So foundset.getSelectedRecord() can return null.

prs

Parameters

sIndent

event

the event that triggered the action

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

onRender

name

onRender(event)

des

sIndent

The method that is executed when the component is rendered.

prs

Parameters

sIndent

event

the render event

clients

Supported Clients

sIndent

SmartClient,WebClient

sam

Sample

sIdent

javascript

lastDetailRow

onResize

name

onResize(event)

des

sIndent

The method that gets triggered when resize occurs.

prs

Parameters

sIndent

event

the event that triggered the action

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

onShow

name

onShow(firstShow, event)

des

sIndent

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

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

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

prs

Parameters

sIndent

firstShow

form is shown first time after load

event

the event that triggered the action

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

onUnLoad

name

onUnLoad(event)

des

sIndent

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

prs

Parameters

sIndent

event

the event that triggered the action

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 28

New Version 36

Key

onDeleteAllRecords

onDeleteRecord

onDuplicateRecord

onFind

onInvertRecords

onNewRecord

onNextRecord

onOmitRecord

onPreviousRecord

onPrintPreview

onSearch

onShowAllRecords

onShowOmittedRecords

onSort

onDrag

onDragEnd

onDragOver

onDrop

onElementFocusGained

onElementFocusLost

onHide

onLoad

onRecordEditStart

onRecordEditStop

onRecordSelection

onRender

onResize

onShow

onUnLoad

borderType

dataSource

defaultPageFormat

deprecated

designTimeProperties

encapsulation

extendsForm

initialSort

name

namedFoundSet

navigator

paperPrintScale

rowBGColorCalculation

scrollbars

selectionMode

showInMenu

styleClass

styleName

titleText

transparent

view

width

borderType

dataSource

defaultPageFormat

deprecated

designTimeProperties

encapsulation

extendsForm

formComponent

initialSort

name

namedFoundSet

navigator

paperPrintScale

rowBGColorCalculation

scrollbars

selectionMode

showInMenu

styleClass

styleName

titleText

transparent

view

width