Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

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 > Delete All.voidThe method that overrides the Servoy menu item Select > Delete Record (or keyboard shortcut).voidThe method that overrides the Servoy menu item Select > Duplicate Record (or keyboard shortcut).voidThe method that overrides the Servoy menu item Select > Find (or keyboard shortcut) in Data (ready) mode.voidThe method that overrides the Servoy menu item Select > Invert Records.voidThe method that overrides the Servoy menu item Select > New Record (or keyboard shortcut).voidThe method that overrides the Servoy menu item Select > Next Record.voidThe method that overrides the Servoy menu item Select > Omit Record.voidThe method that overrides the Servoy menu item Select > Previous Record.voidThe method that overrides the Servoy menu item File > Print Preview.voidThe method that overrides the Servoy menu item Select > Search (or keyboard shortcut) in Find mode.voidThe method that overrides the Servoy menu item Select > Show All (or keyboard shortcut).voidThe method that overrides the Servoy menu item Select > Show Omitted Records.voidThe 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 loaded/reloaded from the repository; 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.voidThe method that is triggered each time a record is selected.voidThe method that is executed when the component is rendered.voidThe method that gets triggered when resize occurs.voidThe 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.voidThe method that is triggered when a form is unloaded from the repository.

propertyservoy sDetail2100%height:30px2Property DetailsborderTypename

borderType

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowdataSourcename

dataSource

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
defaultPageFormatname

defaultPageFormat

dessIndent
The default page format for the form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
deprecatedname

deprecated

dessIndent
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

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
designTimePropertiesname

designTimeProperties

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

Returns

sIndent map of the design-time properties
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
encapsulationname

encapsulation

dessIndent
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

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
extendsFormname

extendsForm

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

Returns

sIndent the parent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
formComponentname

formComponent

dessIndentret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
initialSortname

initialSort

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
namename

name

dessIndent
The name of the form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
namedFoundSetname

namedFoundSet

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
navigatorname

navigator

dessIndent
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

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
paperPrintScalename

paperPrintScale

dessIndent
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

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
rowBGColorCalculationname

rowBGColorCalculation

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
scrollbarsname

scrollbars

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
selectionModename

selectionMode

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
showInMenuname

showInMenu

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
styleClassname

styleClass

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
styleNamename

styleName

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
titleTextname

titleText

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
transparentname

transparent

dessIndent
When set, the form is transparent.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
viewname

view

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
widthname

width

dessIndent
The width of the form in pixels.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

commandservoy sDetail2100%height:30px2Command DetailsonDeleteAllRecordsname

onDeleteAllRecords

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRowonDeleteRecordname

onDeleteRecord

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
onDuplicateRecordname

onDuplicateRecord

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
onFindname

onFind

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
onInvertRecordsname

onInvertRecords

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
onNewRecordname

onNewRecord

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
onNextRecordname

onNextRecord

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
onOmitRecordname

onOmitRecord

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
onPreviousRecordname

onPreviousRecord

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
onPrintPreviewname

onPrintPreview

dessIndent
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

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
onSearchname

onSearch

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
onShowAllRecordsname

onShowAllRecords

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
onShowOmittedRecordsname

onShowOmittedRecords

dessIndent
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

sIndentSmartClient
sam

Sample

sIdentjavascript
lastDetailRow
onSortname

onSort

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

eventservoy sDetail2100%height:30px2Event DetailsonDragname

onDrag(event)

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

Parameters

sIndenteventthe event that triggered the action
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRowonDragEndname

onDragEnd(event)

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

Parameters

sIndenteventthe event that triggered the action
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
onDragOvername

onDragOver(event)

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

Parameters

sIndenteventthe event that triggered the action
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
onDropname

onDrop(event)

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

Parameters

sIndenteventthe event that triggered the action
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
onElementDataChangename

onElementDataChange(oldValue, newValue, event)

dessIndent
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

sIndentoldValueold valuenewValuenew valueeventthe event that triggered the action
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onElementFocusGainedname

onElementFocusGained(event)

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

Parameters

sIndenteventthe event that triggered the action
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onElementFocusLostname

onElementFocusLost(event)

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

Parameters

sIndenteventthe event that triggered the action
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onHidename

onHide(event)

dessIndent
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

sIndenteventthe event that triggered the action
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
onLoadname

onLoad(event)

dessIndent
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

sIndenteventthe event that triggered the action
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
onRecordEditStartname

onRecordEditStart(event)

dessIndent
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

sIndenteventthe event that triggered the action
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onRecordEditStopname

onRecordEditStop(record, event)

dessIndent
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

sIndentrecordrecord being savedeventthe event that triggered the action
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onRecordSelectionname

onRecordSelection(event)

dessIndent
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

sIndenteventthe event that triggered the action
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
onRendername

onRender(event)

dessIndent
The method that is executed when the component is rendered.
prs

Parameters

sIndenteventthe render event
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
onResizename

onResize(event)

dessIndent
The method that gets triggered when resize occurs.
prs

Parameters

sIndenteventthe event that triggered the action
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onShowname

onShow(firstShow, event)

dessIndent
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

sIndentfirstShowform is shown first time after loadeventthe event that triggered the action
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
onUnLoadname

onUnLoad(event)

dessIndent
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

sIndenteventthe event that triggered the action
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow