Child pages
  • controller

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay: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.

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
enabled
Gets or sets the enabled state of a form; also known as "grayed-out".
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
readOnly

Gets or sets the read-only state of a form; also known as "editable"

Note: The field(s) in a form set as read-only can be selected and the field data can be copied to clipboard.

Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
view
Get/Set the current type of view of this form.



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
deleteAllRecords()
Deletes all records in foundset, resulting in empty foundset.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
deleteRecord()
Delete current selected record, deletes mulitple selected records incase the foundset is using multiselect.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
duplicateRecord()
Duplicate current record or record at index in the form foundset.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
duplicateRecord(location)
Duplicate current record or record at index in the form foundset.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
duplicateRecord(location)
Duplicate current record or record at index in the form foundset.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
find()
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
focusField(fieldName, skipReadonly)
Sets focus to a field specified by its name.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
focusFirstField()
Sets focus to the first field of the form; based on tab order sequence.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getDataProviderMaxLength(name)
Returns the maximum length allowed in the specified dataprovider.
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
getDataProviderValue(dataProvider)
Gets a value based on the specified dataprovider name.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getDataSource()
Get the used datasource.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
getDesignMode()
Returns the state of this form designmode.
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
getDesignTimeProperty()
Get a design-time property of a form.
Table Row (tr)
Table Cell (td)
JSDataSet
Table Cell (td)
getFormContext()
Gets the forms context where it resides, returns a dataset of its structure to the main controller.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getFormWidth()
Gets the form width in pixels.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getMaxRecordIndex()
Returns the current cached record count of the current foundset.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getName()
Get the name of this form.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getPartHeight(partType)
Gets the part height in pixels.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getPartYOffset(partType)
Returns the Y offset of a given part of the form.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getSelectedIndex()
Gets the current record index of the current foundset.
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
getTabSequence()
Get an array with the names of the components that are part of the tab sequence.
Table Row (tr)
Table Cell (td)
JSWindow
Table Cell (td)
getWindow()
Returns the JSWindow that the form is shown in, or null if the form is not currently showing in a window.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
invertRecords()
Inverts the current foundset against all rows of the current table; all records that are not in the foundset will become the current foundset.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
loadAllRecords()
Loads all accessible records from the datasource into the form foundset.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
loadOmittedRecords()
Loads the records that are currently omitted in the form foundset.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
loadRecords()
Loads all accessible records from the datasource into the form foundset.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
loadRecords(foundset)
Loads a (related) foundset into the form.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
loadRecords(pkdataset)
Loads a primary key dataset, will remove related sort.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
loadRecords(UUIDpk)
Loads a single record by primary key, will remove related sort.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
loadRecords(singlenNmber_pk)
Loads a single record by primary key, will remove related sort.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
loadRecords(queryString)
Loads records into form foundset based on a query (also known as 'Form by query').
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
loadRecords(queryString, queryArgumentsArray)
Loads records into form foundset based on a query (also known as 'Form by query').
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
newRecord()
Create a new record in the form foundset.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
newRecord(insertOnTop)
Create a new record in the form foundset.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
newRecord(location)
Create a new record in the form foundset.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
omitRecord()
Omit current record in form foundset, to be shown with loadOmittedRecords.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
print()
Print this form with current foundset, without preview.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
print(printCurrentRecordOnly)
Print this form with current foundset, without preview.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
print(printCurrentRecordOnly, showPrinterSelectDialog)
Print this form with current foundset, without preview.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
print(printCurrentRecordOnly, showPrinterSelectDialog, printerJob)
Print this form with current foundset, without preview.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
printXML()
Print this form with current foundset records to xml format.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
printXML(printCurrentRecordOnly)
Print this form with current foundset records to xml format.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
recreateUI()
Recreates the forms UI components, to reflect the latest solution model.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
relookup()
Performs a relookup for the current foundset record dataproviders.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
search()
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
search(clearLastResults)
Start the database search and use the results, returns the number of records, make sure you did "find" function first.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
search(clearLastResults, reduceSearch)
Start the database search and use the results, returns the number of records, make sure you did "find" function first.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setDataProviderValue(dataprovider, value)
Sets the value based on a specified dataprovider name.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setDesignMode(designMode)
Sets this form in designmode with param true, false will return to normal browse/edit mode.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setDesignMode(ondrag)
Sets this form in designmode with one or more callback methods.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setDesignMode(ondrag, ondrop)
Sets this form in designmode with one or more callback methods.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setDesignMode(ondrag, ondrop, onselect)
Sets this form in designmode with one or more callback methods.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setDesignMode(ondrag, ondrop, onselect, onresize)
Sets this form in designmode with one or more callback methods.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setDesignMode(ondrag, ondrop, onselect, onresize, ondblclick)
Sets this form in designmode with one or more callback methods.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setDesignMode(ondrag, ondrop, onselect, onresize, ondblclick, onrightclick)
Sets this form in designmode with one or more callback methods.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin)
Set the page format to use when printing.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation)
Set the page format to use when printing.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation, units)
Set the page format to use when printing.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setPreferredPrinter(printerName)
Set the preferred printer name to use when printing.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setSelectedIndex(index)
Sets the current record index of the current foundset.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setTabSequence(arrayOfElements)
Set the tab order sequence programatically, by passing the elements references in a javascript array.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
show()
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
show(window)
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
show(window)
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showPrintPreview()
Show this form in print preview.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showPrintPreview(printCurrentRecordOnly)
Show this form in print preview.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showPrintPreview(printCurrentRecordOnly, printerJob)
Show this form in print preview.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showPrintPreview(printCurrentRecordOnly, printerJob, zoomFactor)
Show this form in print preview.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(foundset)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(foundset, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(foundset, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(pkdataset)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(pkdataset, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(pkdataset, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(query)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(query, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(query, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(UUIDpk)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(UUIDpk, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(UUIDpk, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(singleNumber_pk)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(singleNumber_pk, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(singleNumber_pk, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(query)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(query, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(query, argumentsArray)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(query, argumentsArray, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(query, argumentsArray, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
showRecords(query, window)
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
sort(sortString)
Sorts the form foundset based on the given sort string.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
sort(sortString, defer)
Sorts the form foundset based on the given sort string.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
sortDialog()
Show the sort dialog to the user a preselection sortString can be passed, to sort the form foundset.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
sortDialog(sortString)



HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Details
Table Body (tbody)
idenabled
Table Row (tr)
idname
Table Cell (td)

enabled

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Gets or sets the enabled state of a form; also known as "grayed-out".

Notes:
-A disabled element(s) cannot be selected by clicking the form.
-The disabled "grayed" color is dependent on the LAF set in the Servoy Smart Client Application Preferences.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//gets the enabled state of the form
var state = forms.customer.controller.enabled;
//enables the form for input
forms.customer.controller.enabled = true;
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idreadOnly
Table Row (tr)
idname
Table Cell (td)

readOnly

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Gets or sets the read-only state of a form; also known as "editable"

Note: The field(s) in a form set as read-only can be selected and the field data can be copied to clipboard.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//gets the read-only state of the form
var state = forms.customer.controller.readOnly;
//sets the read-only state of the form
forms.customer.controller.readOnly = true
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idview
Table Row (tr)
idname
Table Cell (td)

view

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get/Set the current type of view of this form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//gets the type of view for this form
var view = forms.customer.controller.view;
//sets the form to Record view
forms.customer.controller.view = 0;//RECORD_VIEW
//sets the form to List view
forms.customer.controller.view = 1;//LIST_VIEW
Table Row (tr)
classlastDetailRow
Table Cell (td)
 



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
iddeleteAllRecords
Table Row (tr)
idname
Table Cell (td)

deleteAllRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
deleteAllRecords
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Deletes all records in foundset, resulting in empty foundset.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - false incase of related foundset having records and orphans records are not allowed by the relation
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var success = forms.customer.controller.deleteAllRecords();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddeleteRecord
Table Row (tr)
idname
Table Cell (td)

deleteRecord

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
deleteRecord
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Delete current selected record, deletes mulitple selected records incase the foundset is using multiselect.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - false incase of related foundset having records and orphans records are not allowed by the relation
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var success = forms.customer.controller.deleteRecord();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idduplicateRecord
Table Row (tr)
idname
Table Cell (td)

duplicateRecord

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
duplicateRecord
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Duplicate current record or record at index in the form foundset.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if succesful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.duplicateRecord(); //duplicate the current record, adds on top
//forms.customer.controller.duplicateRecord(false); //duplicate the current record, adds at bottom
//forms.customer.controller.duplicateRecord(1,2); //duplicate the first record as second record
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idduplicateRecord-Boolean
Table Row (tr)
idname
Table Cell (td)

duplicateRecord

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
duplicateRecord
Span
(location)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Duplicate current record or record at index in the form foundset.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} location - true adds the new record as the topmost record
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.duplicateRecord(); //duplicate the current record, adds on top
//forms.customer.controller.duplicateRecord(false); //duplicate the current record, adds at bottom
//forms.customer.controller.duplicateRecord(1,2); //duplicate the first record as second record
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idduplicateRecord-Number
Table Row (tr)
idname
Table Cell (td)

duplicateRecord

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
duplicateRecord
Span
(location)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Duplicate current record or record at index in the form foundset.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} location - adds at specified index
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.duplicateRecord(); //duplicate the current record, adds on top
//forms.customer.controller.duplicateRecord(false); //duplicate the current record, adds at bottom
//forms.customer.controller.duplicateRecord(1,2); //duplicate the first record as second record
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idfind
Table Row (tr)
idname
Table Cell (td)

find

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
find
Span
()
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
if (forms.customer.controller.find()) //find will fail if autosave is disabled and there are unsaved records
{
	columnTextDataProvider = 'a search value'
	columnNumberDataProvider = '>10'
	columnDateDataProvider = '31-12-2010|dd-MM-yyyy'
	forms.customer.controller.search()
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idfocusField-String_Boolean
Table Row (tr)
idname
Table Cell (td)

focusField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
focusField
Span
(fieldName, skipReadonly)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets focus to a field specified by its name.
If the second parameter is set to true, then readonly fields will be skipped
(the focus will be set to the first non-readonly field located after the field with the specified name; the tab sequence is respected when searching for the non-readonly field).
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} fieldName - the name of the field to be focussed
{Boolean} skipReadonly - indication to skip read only fields, if the named field happens to be read only
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var tabseq = forms.customer.controller.getTabSequence();
if (tabseq.length > 1) {
	// If there is more than one field in the tab sequence,
	// focus the second one and skip over readonly fields.
	forms.customer.controller.focusField(tabseq[1], true);
}
else {
	// If there is at most one field in the tab sequence, then focus
	// whatever field is first, and don't bother to skip over readonly fields.
	forms.customer.controller.focusField(null, false);
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idfocusFirstField
Table Row (tr)
idname
Table Cell (td)

focusFirstField

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
focusFirstField
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets focus to the first field of the form; based on tab order sequence.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.focusFirstField();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDataProviderMaxLength-String
Table Row (tr)
idname
Table Cell (td)

getDataProviderMaxLength

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getDataProviderMaxLength
Span
(name)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the maximum length allowed in the specified dataprovider.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} name - the dataprovider name
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - the length
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.getDataProviderMaxLength('name');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDataProviderValue-String
Table Row (tr)
idname
Table Cell (td)

getDataProviderValue

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
getDataProviderValue
Span
(dataProvider)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets a value based on the specified dataprovider name.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataProvider - the dataprovider name to retieve the value for
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object - the dataprovider value (null if unknown dataprovider)
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var val = forms.customer.controller.getDataProviderValue('contact_name');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDataSource
Table Row (tr)
idname
Table Cell (td)

getDataSource

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getDataSource
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the used datasource.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - the datasource
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var dataSource = forms.customer.controller.getDataSource();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDesignMode
Table Row (tr)
idname
Table Cell (td)

getDesignMode

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
getDesignMode
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the state of this form designmode.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - the design mode state (true/fase)
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var success = forms.customer.controller.getDesignMode();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDesignTimeProperty
Table Row (tr)
idname
Table Cell (td)

getDesignTimeProperty

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Object
Span
stylefont-weight: bold;
getDesignTimeProperty
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get a design-time property of a form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var prop = forms.orders.controller.getDesignTimeProperty('myprop')
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetFormContext
Table Row (tr)
idname
Table Cell (td)

getFormContext

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSDataSet
Span
stylefont-weight: bold;
getFormContext
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the forms context where it resides, returns a dataset of its structure to the main controller.
Note1: can't be called in onload, because no context is yet available at this time.
Note2: tabindex is 1 (left) or 2 (right) for a SplitPane and 0 based for the other tabpanels; tabindex1based is the same as tabindex but is 1 based.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSDataSet - the dataset with form context
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//dataset columns: [containername(1),formname(2),tabpanel or beanname(3),tabname(4),tabindex(5),tabindex1based(6)]
//dataset rows: mainform(1) -> parent(2)  -> current form(3) (when 3 forms deep)
/** @type {JSDataSet} */
var dataset = forms.customer.controller.getFormContext();
if (dataset.getMaxRowIndex() > 1)
{
	// form is in a tabpanel
	var parentFormName = dataset.getValue(1,2)
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetFormWidth
Table Row (tr)
idname
Table Cell (td)

getFormWidth

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getFormWidth
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the form width in pixels.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - the width in pixels
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var width = forms.customer.controller.getFormWidth();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetMaxRecordIndex
Table Row (tr)
idname
Table Cell (td)

getMaxRecordIndex

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getMaxRecordIndex
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the current cached record count of the current foundset.
To return the full foundset count, use: databaseManager.getFoundSetCount(...)
Tip: get the the table count of all rows in a table, use: databaseManager.getTableCount(...)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - the max record index
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
for ( var i = 1 ; i <= forms.customer.controller.getMaxRecordIndex() ; i++ )
{
	forms.customer.controller.setSelectedIndex(i);
	//do some action per record
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetName
Table Row (tr)
idname
Table Cell (td)

getName

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getName
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the name of this form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - the name
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var formName = forms.customer.controller.getName();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetPartHeight-Number
Table Row (tr)
idname
Table Cell (td)

getPartHeight

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getPartHeight
Span
(partType)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the part height in pixels.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} partType - The type of the part whose height will be returned.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - the part height in pixels
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var height = forms.customer.controller.getPartHeight(JSPart.BODY);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetPartYOffset-Number
Table Row (tr)
idname
Table Cell (td)

getPartYOffset

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getPartYOffset
Span
(partType)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the Y offset of a given part of the form.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} partType - The type of the part whose Y offset will be returned.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - A number holding the Y offset of the specified form part.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var offset = forms.customer.controller.getPartYOffset(JSPart.BODY);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetSelectedIndex
Table Row (tr)
idname
Table Cell (td)

getSelectedIndex

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getSelectedIndex
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the current record index of the current foundset.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - the index
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//gets the current record index in the current foundset
var current = forms.customer.controller.getSelectedIndex();
//sets the next record in the foundset, will be reflected in UI
forms.customer.controller.setSelectedIndex(current+1);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetTabSequence
Table Row (tr)
idname
Table Cell (td)

getTabSequence

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getTabSequence
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get an array with the names of the components that are part of the tab sequence.
The order of the names respects the order of the tab sequence.
Components that are not named will not appear in the returned array, although they may be in the tab sequence.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[] - array of names
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var tabseq = forms.customer.controller.getTabSequence();
if (tabseq.length > 1) {
	// If there is more than one field in the tab sequence,
	// focus the second one and skip over readonly fields.
	forms.customer.controller.focusField(tabseq[1], true);
}
else {
	// If there is at most one field in the tab sequence, then focus
	// whatever field is first, and don't bother to skip over readonly fields.
	forms.customer.controller.focusField(null, false);
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetWindow
Table Row (tr)
idname
Table Cell (td)

getWindow

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSWindow
Span
stylefont-weight: bold;
getWindow
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the JSWindow that the form is shown in, or null if the form is not currently showing in a window.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSWindow - the JSWindow that the form is shown in, or null if the form is not currently showing in a window.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var currentWindow = controller.getWindow();
if (currentWindow != null) {
	currentWindow.title = 'We have a new title';
} else {
	currentWindow = application.createWindow("Window Name", JSWindow.WINDOW, null);
	currentWindow(650, 700, 450, 350);
	currentWindow = "Window Title";
	controller.show(currentWindow);
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idinvertRecords
Table Row (tr)
idname
Table Cell (td)

invertRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
invertRecords
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Inverts the current foundset against all rows of the current table; all records that are not in the foundset will become the current foundset.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.invertRecords();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idloadAllRecords
Table Row (tr)
idname
Table Cell (td)

loadAllRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
loadAllRecords
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Loads all accessible records from the datasource into the form foundset.
When the form contains a related foundset it will be replaced by a default foundset on same datasource.

Notes:
-the default foundset is always limited by filters, if databaseManager.addFoundSetFilterParam function is used.
-typical use is loading the normal foundset again after form usage in a related tabpanel

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.loadAllRecords();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idloadOmittedRecords
Table Row (tr)
idname
Table Cell (td)

loadOmittedRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
loadOmittedRecords
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Loads the records that are currently omitted in the form foundset.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.loadOmittedRecords();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idloadRecords
Table Row (tr)
idname
Table Cell (td)

loadRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
loadRecords
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Loads all accessible records from the datasource into the form foundset. Typical usage is loading records after search in related tabpanel.
The difference to loadAllRecords() is that related foundset will load related records.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//to reload all last (related) records again, if for example after a search in related tabpanel
forms.customer.controller.loadRecords();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idloadRecords-JSFoundSet
Table Row (tr)
idname
Table Cell (td)

loadRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
loadRecords
Span
(foundset)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Loads a (related) foundset into the form.
The form will no longer share the default foundset with forms of the same datasource, use loadAllRecords to restore the default foundset.

This will really update the foundset instance itself of the form, so now existing foundset is altered just the new foundset is shown.
This is different then doing foundset.loadRecords(foundset) because that just alters the current foundset and doesn't do anything with the foundset
that is given.

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSFoundSet} foundset - to load
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//to load a (related)foundset into the form.
//the form will no longer share the default foundset with forms of the same datasource, use loadAllRecords to restore the default foundset
forms.customer.controller.loadRecords(order_to_orderdetails);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idloadRecords-JSDataSet
Table Row (tr)
idname
Table Cell (td)

loadRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
loadRecords
Span
(pkdataset)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Loads a primary key dataset, will remove related sort.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSDataSet} pkdataset - to load
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//to load a primary key dataset, will remove related sort
//var dataset = databaseManager.getDataSetByQuery(...);
// dataset must match the table primary key columns (alphabetically ordered)
forms.customer.controller.loadRecords(dataset);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idloadRecords-UUID
Table Row (tr)
idname
Table Cell (td)

loadRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
loadRecords
Span
(UUIDpk)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Loads a single record by primary key, will remove related sort.

NOTE: This function will return true if the foundset was altered/changed. It is up to the developer to check for the presence of actual data using getSize().

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{UUID} UUIDpk - to load
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.loadRecords(application.getUUID('6b5e2f5d-047e-45b3-80ee-3a32267b1f20'));
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idloadRecords-Number
Table Row (tr)
idname
Table Cell (td)

loadRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
loadRecords
Span
(singlenNmber_pk)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Loads a single record by primary key, will remove related sort.

NOTE: This function will return true if the foundset was altered/changed. It is up to the developer to check for the presence of actual data using getSize().

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} singlenNmber_pk - to load
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.loadRecords(123);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idloadRecords-String
Table Row (tr)
idname
Table Cell (td)

loadRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
loadRecords
Span
(queryString)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Loads records into form foundset based on a query (also known as 'Form by query'). The query must be a valid sql select.
If the foundset is related this function is not allowed.

see foundset.loadRecords(QBSelect).

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} queryString - to load
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.loadRecords(sqlstring);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idloadRecords-String_ObjectArray
Table Row (tr)
idname
Table Cell (td)

loadRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
loadRecords
Span
(queryString, queryArgumentsArray)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Loads records into form foundset based on a query (also known as 'Form by query'). The query must be a valid sql select.
If the foundset is related this function is not allowed.

see foundset.loadRecords(QBSelect).

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} queryString - to load
{Object[]} queryArgumentsArray - the arguments to replace the questions marks in the queryString
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.loadRecords(sqlstring,parameters);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewRecord
Table Row (tr)
idname
Table Cell (td)

newRecord

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
newRecord
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Create a new record in the form foundset.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if succesful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// foreign key data is only filled in for equals (=) relation items
forms.customer.controller.newRecord();//default adds on top
//forms.customer.controller.newRecord(false); //adds at bottom
//forms.customer.controller.newRecord(2); //adds as second record
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewRecord-Boolean
Table Row (tr)
idname
Table Cell (td)

newRecord

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
newRecord
Span
(insertOnTop)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Create a new record in the form foundset.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} insertOnTop - true adds the new record as the topmost record
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// foreign key data is only filled in for equals (=) relation items
forms.customer.controller.newRecord();//default adds on top
//forms.customer.controller.newRecord(false); //adds at bottom
//forms.customer.controller.newRecord(2); //adds as second record
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idnewRecord-Number
Table Row (tr)
idname
Table Cell (td)

newRecord

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
newRecord
Span
(location)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Create a new record in the form foundset.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} location - adds at specified index
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// foreign key data is only filled in for equals (=) relation items
forms.customer.controller.newRecord();//default adds on top
//forms.customer.controller.newRecord(false); //adds at bottom
//forms.customer.controller.newRecord(2); //adds as second record
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idomitRecord
Table Row (tr)
idname
Table Cell (td)

omitRecord

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
omitRecord
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Omit current record in form foundset, to be shown with loadOmittedRecords.

Note: The omitted records are discarded when these functions are executed: loadAllRecords, loadRecords(dataset), loadRecords(sqlstring), invert

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var success = forms.customer.controller.omitRecord();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idprint
Table Row (tr)
idname
Table Cell (td)

print

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
print
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Print this form with current foundset, without preview.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//print this form (with foundset records)
forms.customer.controller.print();
//print only current record (no printerSelectDialog) to pdf plugin printer
//forms.customer.controller.print(true,false,plugins.pdf_output.getPDFPrinter('c:/temp/out.pdf'));
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idprint-Boolean
Table Row (tr)
idname
Table Cell (td)

print

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
print
Span
(printCurrentRecordOnly)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Print this form with current foundset, without preview.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} printCurrentRecordOnly - to print the current record only
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//print this form (with foundset records)
forms.customer.controller.print();
//print only current record (no printerSelectDialog) to pdf plugin printer
//forms.customer.controller.print(true,false,plugins.pdf_output.getPDFPrinter('c:/temp/out.pdf'));
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idprint-Boolean_Boolean
Table Row (tr)
idname
Table Cell (td)

print

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
print
Span
(printCurrentRecordOnly, showPrinterSelectDialog)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Print this form with current foundset, without preview.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} printCurrentRecordOnly - to print the current record only
{Boolean} showPrinterSelectDialog - to show the printer select dialog (default printer is normally used)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//print this form (with foundset records)
forms.customer.controller.print();
//print only current record (no printerSelectDialog) to pdf plugin printer
//forms.customer.controller.print(true,false,plugins.pdf_output.getPDFPrinter('c:/temp/out.pdf'));
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idprint-Boolean_Boolean_PrinterJob
Table Row (tr)
idname
Table Cell (td)

print

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
print
Span
(printCurrentRecordOnly, showPrinterSelectDialog, printerJob)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Print this form with current foundset, without preview.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} printCurrentRecordOnly - to print the current record only
{Boolean} showPrinterSelectDialog - to show the printer select dialog (default printer is normally used)
{PrinterJob} printerJob - print to plugin printer job, see pdf printer plugin for example
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//print this form (with foundset records)
forms.customer.controller.print();
//print only current record (no printerSelectDialog) to pdf plugin printer
//forms.customer.controller.print(true,false,plugins.pdf_output.getPDFPrinter('c:/temp/out.pdf'));
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idprintXML
Table Row (tr)
idname
Table Cell (td)

printXML

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
printXML
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Print this form with current foundset records to xml format.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - the XML
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//TIP: see also plugins.file.writeXMLFile(...)
var xml = forms.customer.controller.printXML();
//print only current record
//var xml = forms.customer.controller.printXML(true);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idprintXML-Boolean
Table Row (tr)
idname
Table Cell (td)

printXML

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
printXML
Span
(printCurrentRecordOnly)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Print this form with current foundset records to xml format.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} printCurrentRecordOnly - to print the current record only
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - the XML
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//TIP: see also plugins.file.writeXMLFile(...)
var xml = forms.customer.controller.printXML();
//print only current record
//var xml = forms.customer.controller.printXML(true);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idrecreateUI
Table Row (tr)
idname
Table Cell (td)

recreateUI

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Boolean
Span
stylefont-weight: bold;
recreateUI
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Recreates the forms UI components, to reflect the latest solution model.
Use this after altering the elements via solutionModel at the JSForm of this form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - true if successful
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// get the solution model JSForm
var form = solutionModel.getForm("myForm");
// get the JSField of the form
var field = form.getField("myField");
// alter the field
field.x = field.x + 10;
// recreate the runtime forms ui to reflect the changes.
forms.customer.controller.recreateUI();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idrelookup
Table Row (tr)
idname
Table Cell (td)

relookup

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
relookup
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Performs a relookup for the current foundset record dataproviders.
Lookups are defined in the dataprovider (columns) auto-enter setting and are normally performed over a relation upon record creation.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.relookup();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsearch
Table Row (tr)
idname
Table Cell (td)
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
search
Span
()
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var recordCount = forms.customer.controller.search();
//var recordCount = forms.customer.controller.search(false,false); //to extend foundset
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsearch-Boolean
Table Row (tr)
idname
Table Cell (td)

search

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
search
Span
(clearLastResults)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Start the database search and use the results, returns the number of records, make sure you did "find" function first.
Reduce results from previous searches.

Note: Omitted records are automatically excluded when performing a search - meaning that the foundset result by default will not include omitted records.

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} clearLastResults - boolean, clear previous search, default true
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - the recordCount
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var recordCount = forms.customer.foundset.search();
//var recordCount = forms.customer.foundset.search(false,false); //to extend foundset
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsearch-Boolean_Boolean
Table Row (tr)
idname
Table Cell (td)

search

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
search
Span
(clearLastResults, reduceSearch)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Start the database search and use the results, returns the number of records, make sure you did "find" function first.

Note: Omitted records are automatically excluded when performing a search - meaning that the foundset result by default will not include omitted records.

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} clearLastResults - boolean, clear previous search, default true
{Boolean} reduceSearch - boolean, reduce (true) or extend (false) previous search results, default true
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - the recordCount
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var recordCount = forms.customer.foundset.search();
//var recordCount = forms.customer.foundset.search(false,false); //to extend foundset
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetDataProviderValue-String_Object
Table Row (tr)
idname
Table Cell (td)

setDataProviderValue

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setDataProviderValue
Span
(dataprovider, value)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets the value based on a specified dataprovider name.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} dataprovider - the dataprovider name to set the value for
{Object} value - the value to set in the dataprovider
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.setDataProviderValue('contact_name','mycompany');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetDesignMode-Boolean
Table Row (tr)
idname
Table Cell (td)

setDesignMode

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setDesignMode
Span
(designMode)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets this form in designmode with param true, false will return to normal browse/edit mode.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} designMode - sets form in design mode if true, false ends design mode.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = forms["selectedFormName"];
if (!form.controller.getDesignMode())
{
	// Set the current form in designmode with no callbacks
	form.controller.setDesignMode(true);
	// Set the current form in designmode with callbacks
	// where onDrag, onDrop, onSelect, onResize are names of form methods (not from "selectedFormName" form)
	// form.controller.setDesignMode(onDrag, onDrop, onSelect, onResize);
}
//Set the current form out of designmode (to normal browse)
//form.controller.setDesignMode(false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetDesignMode-Function
Table Row (tr)
idname
Table Cell (td)

setDesignMode

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setDesignMode
Span
(ondrag)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets this form in designmode with one or more callback methods.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} ondrag - onDrag method reference
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = forms["selectedFormName"];
if (!form.controller.getDesignMode())
{
	// Set the current form in designmode with no callbacks
	form.controller.setDesignMode(true);
	// Set the current form in designmode with callbacks
	// where onDrag, onDrop, onSelect, onResize are names of form methods (not from "selectedFormName" form)
	// form.controller.setDesignMode(onDrag, onDrop, onSelect, onResize);
}
//Set the current form out of designmode (to normal browse)
//form.controller.setDesignMode(false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetDesignMode-Function_Function
Table Row (tr)
idname
Table Cell (td)

setDesignMode

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setDesignMode
Span
(ondrag, ondrop)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets this form in designmode with one or more callback methods.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} ondrag - onDrag method reference
{Function} ondrop - onDrop method reference
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = forms["selectedFormName"];
if (!form.controller.getDesignMode())
{
	// Set the current form in designmode with no callbacks
	form.controller.setDesignMode(true);
	// Set the current form in designmode with callbacks
	// where onDrag, onDrop, onSelect, onResize are names of form methods (not from "selectedFormName" form)
	// form.controller.setDesignMode(onDrag, onDrop, onSelect, onResize);
}
//Set the current form out of designmode (to normal browse)
//form.controller.setDesignMode(false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetDesignMode-Function_Function_Function
Table Row (tr)
idname
Table Cell (td)

setDesignMode

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setDesignMode
Span
(ondrag, ondrop, onselect)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets this form in designmode with one or more callback methods.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} ondrag - onDrag method reference
{Function} ondrop - onDrop method reference
{Function} onselect - onSelect method reference
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = forms["selectedFormName"];
if (!form.controller.getDesignMode())
{
	// Set the current form in designmode with no callbacks
	form.controller.setDesignMode(true);
	// Set the current form in designmode with callbacks
	// where onDrag, onDrop, onSelect, onResize are names of form methods (not from "selectedFormName" form)
	// form.controller.setDesignMode(onDrag, onDrop, onSelect, onResize);
}
//Set the current form out of designmode (to normal browse)
//form.controller.setDesignMode(false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetDesignMode-Function_Function_Function_Function
Table Row (tr)
idname
Table Cell (td)

setDesignMode

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setDesignMode
Span
(ondrag, ondrop, onselect, onresize)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets this form in designmode with one or more callback methods.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} ondrag - onDrag method reference
{Function} ondrop - onDrop method reference
{Function} onselect - onSelect method reference
{Function} onresize - onResize method reference
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = forms["selectedFormName"];
if (!form.controller.getDesignMode())
{
	// Set the current form in designmode with no callbacks
	form.controller.setDesignMode(true);
	// Set the current form in designmode with callbacks
	// where onDrag, onDrop, onSelect, onResize are names of form methods (not from "selectedFormName" form)
	// form.controller.setDesignMode(onDrag, onDrop, onSelect, onResize);
}
//Set the current form out of designmode (to normal browse)
//form.controller.setDesignMode(false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetDesignMode-Function_Function_Function_Function_Function
Table Row (tr)
idname
Table Cell (td)

setDesignMode

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setDesignMode
Span
(ondrag, ondrop, onselect, onresize, ondblclick)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets this form in designmode with one or more callback methods.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} ondrag - onDrag method reference
{Function} ondrop - onDrop method reference
{Function} onselect - onSelect method reference
{Function} onresize - onResize method reference
{Function} ondblclick - onDblClick method reference
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = forms["selectedFormName"];
if (!form.controller.getDesignMode())
{
	// Set the current form in designmode with no callbacks
	form.controller.setDesignMode(true);
	// Set the current form in designmode with callbacks
	// where onDrag, onDrop, onSelect, onResize are names of form methods (not from "selectedFormName" form)
	// form.controller.setDesignMode(onDrag, onDrop, onSelect, onResize);
}
//Set the current form out of designmode (to normal browse)
//form.controller.setDesignMode(false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetDesignMode-Function_Function_Function_Function_Function_Function
Table Row (tr)
idname
Table Cell (td)

setDesignMode

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setDesignMode
Span
(ondrag, ondrop, onselect, onresize, ondblclick, onrightclick)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets this form in designmode with one or more callback methods.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Function} ondrag - onDrag method reference
{Function} ondrop - onDrop method reference
{Function} onselect - onSelect method reference
{Function} onresize - onResize method reference
{Function} ondblclick - onDblClick method reference
{Function} onrightclick - onRightClick method reference
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var form = forms["selectedFormName"];
if (!form.controller.getDesignMode())
{
	// Set the current form in designmode with no callbacks
	form.controller.setDesignMode(true);
	// Set the current form in designmode with callbacks
	// where onDrag, onDrop, onSelect, onResize are names of form methods (not from "selectedFormName" form)
	// form.controller.setDesignMode(onDrag, onDrop, onSelect, onResize);
}
//Set the current form out of designmode (to normal browse)
//form.controller.setDesignMode(false);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetPageFormat-Number_Number_Number_Number_Number_Number
Table Row (tr)
idname
Table Cell (td)

setPageFormat

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setPageFormat
Span
(width, height, leftmargin, rightmargin, topmargin, bottommargin)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Set the page format to use when printing.

Orientation values:
0 - Landscape mode
1 - Portrait mode

Units values:
0 - millimeters
1 - inches
2 - pixels

Note: The unit specified for width, height and all margins MUST be the same.

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} width - the specified width of the page to be printed.
{Number} height - the specified height of the page to be printed.
{Number} leftmargin - the specified left margin of the page to be printed.
{Number} rightmargin - the specified right margin of the page to be printed.
{Number} topmargin - the specified top margin of the page to be printed.
{Number} bottommargin - the specified bottom margin of the page to be printed.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//Set page format to a custom size of 100x200 pixels with 10 pixel margins on all sides in portrait mode
forms.customer.controller.setPageFormat(100, 200, 10, 10, 10, 10);

//Set page format to a custom size of 100x200 pixels with 10 pixel margins on all sides in landscape mode
forms.customer.controller.setPageFormat(100, 200, 10, 10, 10, 10, SM_ORIENTATION.LANDSCAPE);

//Set page format to a custom size of 100x200 mm in landscape mode
forms.customer.controller.setPageFormat(100, 200, 0, 0, 0, 0, SM_ORIENTATION.LANDSCAPE, SM_UNITS.MM);

//Set page format to a custom size of 100x200 inch in portrait mode
forms.customer.controller.setPageFormat(100, 200, 0, 0, 0, 0, SM_ORIENTATION.PORTRAIT, SM_UNITS.INCH);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetPageFormat-Number_Number_Number_Number_Number_Number_Number
Table Row (tr)
idname
Table Cell (td)

setPageFormat

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setPageFormat
Span
(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Set the page format to use when printing.

Orientation values:
0 - Landscape mode
1 - Portrait mode

Units values:
0 - millimeters
1 - inches
2 - pixels

Note: The unit specified for width, height and all margins MUST be the same.

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} width - the specified width of the page to be printed.
{Number} height - the specified height of the page to be printed.
{Number} leftmargin - the specified left margin of the page to be printed.
{Number} rightmargin - the specified right margin of the page to be printed.
{Number} topmargin - the specified top margin of the page to be printed.
{Number} bottommargin - the specified bottom margin of the page to be printed.
{Number} orientation - the specified orientation of the page to be printed; the default is Portrait mode
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//Set page format to a custom size of 100x200 pixels with 10 pixel margins on all sides in portrait mode
forms.customer.controller.setPageFormat(100, 200, 10, 10, 10, 10);

//Set page format to a custom size of 100x200 pixels with 10 pixel margins on all sides in landscape mode
forms.customer.controller.setPageFormat(100, 200, 10, 10, 10, 10, SM_ORIENTATION.LANDSCAPE);

//Set page format to a custom size of 100x200 mm in landscape mode
forms.customer.controller.setPageFormat(100, 200, 0, 0, 0, 0, SM_ORIENTATION.LANDSCAPE, SM_UNITS.MM);

//Set page format to a custom size of 100x200 inch in portrait mode
forms.customer.controller.setPageFormat(100, 200, 0, 0, 0, 0, SM_ORIENTATION.PORTRAIT, SM_UNITS.INCH);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetPageFormat-Number_Number_Number_Number_Number_Number_Number_Number
Table Row (tr)
idname
Table Cell (td)

setPageFormat

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setPageFormat
Span
(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation, units)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Set the page format to use when printing.

Orientation values:
0 - Landscape mode
1 - Portrait mode

Units values:
0 - millimeters
1 - inches
2 - pixels

Note: The unit specified for width, height and all margins MUST be the same.

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} width - the specified width of the page to be printed.
{Number} height - the specified height of the page to be printed.
{Number} leftmargin - the specified left margin of the page to be printed.
{Number} rightmargin - the specified right margin of the page to be printed.
{Number} topmargin - the specified top margin of the page to be printed.
{Number} bottommargin - the specified bottom margin of the page to be printed.
{Number} orientation - the specified orientation of the page to be printed; the default is Portrait mode
{Number} units - the specified units for the width and height of the page to be printed; the default is pixels
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//Set page format to a custom size of 100x200 pixels with 10 pixel margins on all sides in portrait mode
forms.customer.controller.setPageFormat(100, 200, 10, 10, 10, 10);

//Set page format to a custom size of 100x200 pixels with 10 pixel margins on all sides in landscape mode
forms.customer.controller.setPageFormat(100, 200, 10, 10, 10, 10, SM_ORIENTATION.LANDSCAPE);

//Set page format to a custom size of 100x200 mm in landscape mode
forms.customer.controller.setPageFormat(100, 200, 0, 0, 0, 0, SM_ORIENTATION.LANDSCAPE, SM_UNITS.MM);

//Set page format to a custom size of 100x200 inch in portrait mode
forms.customer.controller.setPageFormat(100, 200, 0, 0, 0, 0, SM_ORIENTATION.PORTRAIT, SM_UNITS.INCH);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetPreferredPrinter-String
Table Row (tr)
idname
Table Cell (td)

setPreferredPrinter

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setPreferredPrinter
Span
(printerName)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set the preferred printer name to use when printing.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} printerName - The name of the printer to be used when printing.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.setPreferredPrinter('HP Laser 2200');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetSelectedIndex-Number
Table Row (tr)
idname
Table Cell (td)

setSelectedIndex

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setSelectedIndex
Span
(index)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets the current record index of the current foundset.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} index - the index to select
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//gets the current record index in the current foundset
var current = forms.customer.controller.getSelectedIndex();
//sets the next record in the foundset, will be reflected in UI
forms.customer.controller.setSelectedIndex(current+1);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetTabSequence-ObjectArray
Table Row (tr)
idname
Table Cell (td)

setTabSequence

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setTabSequence
Span
(arrayOfElements)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Set the tab order sequence programatically, by passing the elements references in a javascript array.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Object[]} arrayOfElements - array containing the element references
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.setTabSequence([forms.customer.elements.fld_order_id, forms.customer.elements.fld_order_amount]);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshow
Table Row (tr)
idname
Table Cell (td)

show

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
show
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// show the form in the current window/dialog
forms.customer.controller.show();
// show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.show(w);
// show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.show(w);
// or forms.customer.controller.show("mydialog");
//show the form in the main window
//forms.customer.controller.show(null);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshow-JSWindow
Table Row (tr)
idname
Table Cell (td)

show

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
show
Span
(window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSWindow} window - the window in which this form should be shown, given as a window object
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// show the form in the current window/dialog
forms.customer.controller.show();
// show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.show(w);
// show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.show(w);
// or forms.customer.controller.show("mydialog");
//show the form in the main window
//forms.customer.controller.show(null);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshow-String
Table Row (tr)
idname
Table Cell (td)

show

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
show
Span
(window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Shows the form (makes the form visible)
This function does not affect the form foundset in any way.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} window - the window in which this form should be shown, specified by the name of an existing window
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// show the form in the current window/dialog
forms.customer.controller.show();
// show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.show(w);
// show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.show(w);
// or forms.customer.controller.show("mydialog");
//show the form in the main window
//forms.customer.controller.show(null);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowPrintPreview
Table Row (tr)
idname
Table Cell (td)

showPrintPreview

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showPrintPreview
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show this form in print preview.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//shows this form (with foundset records) in print preview
forms.customer.controller.showPrintPreview();
//to print preview current record only
//forms.customer.controller.showPrintPreview(true);
//to print preview current record only with 125% zoom factor;
//forms.customer.controller.showPrintPreview(true, null, 125);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowPrintPreview-Boolean
Table Row (tr)
idname
Table Cell (td)

showPrintPreview

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showPrintPreview
Span
(printCurrentRecordOnly)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show this form in print preview.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} printCurrentRecordOnly - to print the current record only
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//shows this form (with foundset records) in print preview
forms.customer.controller.showPrintPreview();
//to print preview current record only
//forms.customer.controller.showPrintPreview(true);
//to print preview current record only with 125% zoom factor;
//forms.customer.controller.showPrintPreview(true, null, 125);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowPrintPreview-Boolean_PrinterJob
Table Row (tr)
idname
Table Cell (td)

showPrintPreview

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showPrintPreview
Span
(printCurrentRecordOnly, printerJob)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show this form in print preview.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} printCurrentRecordOnly - to print the current record only
{PrinterJob} printerJob - print to plugin printer job, see pdf printer plugin for example (incase print is used from printpreview)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//shows this form (with foundset records) in print preview
forms.customer.controller.showPrintPreview();
//to print preview current record only
//forms.customer.controller.showPrintPreview(true);
//to print preview current record only with 125% zoom factor;
//forms.customer.controller.showPrintPreview(true, null, 125);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowPrintPreview-Boolean_PrinterJob_Number
Table Row (tr)
idname
Table Cell (td)

showPrintPreview

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showPrintPreview
Span
(printCurrentRecordOnly, printerJob, zoomFactor)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show this form in print preview.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Boolean} printCurrentRecordOnly - to print the current record only
{PrinterJob} printerJob - print to plugin printer job, see pdf printer plugin for example (incase print is used from printpreview)
{Number} zoomFactor - a specified number value from 10-400
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//shows this form (with foundset records) in print preview
forms.customer.controller.showPrintPreview();
//to print preview current record only
//forms.customer.controller.showPrintPreview(true);
//to print preview current record only with 125% zoom factor;
//forms.customer.controller.showPrintPreview(true, null, 125);
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-JSFoundSet
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(foundset)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSFoundSet} foundset - the foundset to load before showing the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-JSFoundSet_JSWindow
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(foundset, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSFoundSet} foundset - the foundset to load before showing the form.
{JSWindow} window - the window in which this form should be shown, given as a window object.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-JSFoundSet_String
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(foundset, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSFoundSet} foundset - the foundset to load before showing the form.
{String} window - the window in which this form should be shown, specified by the name of an existing window.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-JSDataSet
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(pkdataset)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSDataSet} pkdataset - the pkdataset to load before showing the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-JSDataSet_JSWindow
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(pkdataset, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSDataSet} pkdataset - the pkdataset to load before showing the form.
{JSWindow} window - the window in which this form should be shown, given as a window object.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-JSDataSet_String
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(pkdataset, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSDataSet} pkdataset - the pkdataset to load before showing the form.
{String} window - the window in which this form should be shown, specified by the name of an existing window.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-QBSelect
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(query)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{QBSelect} query - the query to load before showing the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-QBSelect_JSWindow
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(query, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{QBSelect} query - the query to load before showing the form.
{JSWindow} window - the window in which this form should be shown, given as a window object.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-QBSelect_String
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(query, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{QBSelect} query - the query to load before showing the form.
{String} window - the window in which this form should be shown, specified by the name of an existing window.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-UUID
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(UUIDpk)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{UUID} UUIDpk - the UUIDpk to load before showing the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-UUID_JSWindow
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(UUIDpk, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{UUID} UUIDpk - the UUIDpk to load before showing the form.
{JSWindow} window - the window in which this form should be shown, given as a window object.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-UUID_String
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(UUIDpk, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{UUID} UUIDpk - the UUIDpk to load before showing the form.
{String} window - the window in which this form should be shown, specified by the name of an existing window.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-Number
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(singleNumber_pk)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} singleNumber_pk - the singleNumber_pk to load before showing the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-Number_JSWindow
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(singleNumber_pk, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} singleNumber_pk - the singleNumber_pk to load before showing the form.
{JSWindow} window - the window in which this form should be shown, given as a window object
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-Number_String
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(singleNumber_pk, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{Number} singleNumber_pk - the singleNumber_pk to load before showing the form.
{String} window - the window in which this form should be shown, specified by the name of an existing window.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-String
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(query)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} query - the query to load before showing the form.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-String_JSWindow
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(query, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} query - the query to load before showing the form.
{JSWindow} window - the window in which this form should be shown, given as a window object
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-String_ObjectArray
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(query, argumentsArray)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} query - the query to load before showing the form.
{Object[]} argumentsArray - the array of arguments for the query
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-String_ObjectArray_JSWindow
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(query, argumentsArray, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} query - the query to load before showing the form.
{Object[]} argumentsArray - the array of arguments for the query
{JSWindow} window - the window in which this form should be shown, given as a window object
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-String_ObjectArray_String
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(query, argumentsArray, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} query - the query to load before showing the form.
{Object[]} argumentsArray - the array of arguments for the query
{String} window - the window in which this form should be shown, specified by the name of an existing window.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idshowRecords-String_String
Table Row (tr)
idname
Table Cell (td)

showRecords

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
showRecords
Span
(query, window)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} query - the query to load before showing the form.
{String} window - the window in which this form should be shown, specified by the name of an existing window.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.showRecords(foundset);
// load foundset & show the form in newly created named modal dialog
var w = application.createWindow("mydialog", JSWindow.MODAL_DIALOG);
forms.customer.controller.showRecords(foundset, w);
// load foundset & show the form in an existing window/dialog
var w = application.getWindow("mydialog"); // use null name for main app. window
forms.customer.controller.showRecords(foundset, w);
//forms.customer.controller.showRecords(foundset, "mydialog");
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsort-String
Table Row (tr)
idname
Table Cell (td)

sort

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
sort
Span
(sortString)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sorts the form foundset based on the given sort string.
TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} sortString - the specified columns (and sort order)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.sort('columnA desc,columnB asc');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsort-String_Boolean
Table Row (tr)
idname
Table Cell (td)

sort

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
sort
Span
(sortString, defer)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sorts the form foundset based on the given sort string.
TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} sortString - the specified columns (and sort order)
{Boolean} defer - the "sortString" will be just stored, without performing a query on the database (the actual sorting will be deferred until the next data loading action).
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.sort('columnA desc,columnB asc');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsortDialog
Table Row (tr)
idname
Table Cell (td)

sortDialog

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
sortDialog
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Show the sort dialog to the user a preselection sortString can be passed, to sort the form foundset.
TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.sortDialog('columnA desc,columnB asc');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsortDialog-String
Table Row (tr)
idname
Table Cell (td)

sortDialog

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
sortDialog
Span
(sortString)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} sortString - the specified columns (and sort order)
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
forms.customer.controller.sortDialog('columnA desc,columnB asc');
Table Row (tr)
classlastDetailRow
Table Cell (td)