<!--
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURC-->
{column:padding=0px|width=80px}{column}{column}{column}
Property Summery
{column:padding=0px|width=80px}{column}{column}{column}
Method Summery
deleteAllRecords()
Deletes all records in foundset, resulting in empty foundset.
deleteRecord()
Delete current selected record, deletes mulitple selected records incase the foundset is using multiselect.
duplicateRecord([location])
Duplicate current record or record at index in the form foundset.
void
focusField(fieldName, skipReadonly)
Sets focus to a field specified by its name.
void
focusFirstField()
Sets focus to the first field of the form; based on tab order sequence.
getContainerName()
Get the name of the window/dialog this form is displayed in.
getDataProviderMaxLength(name)
Returns the maximum length allowed in the specified dataprovider.
getDataProviderValue(dataProvider)
Gets a value based on the specified dataprovider name.
getDataSource()
Get the used datasource.
getDesignMode()
Returns the state of this form designmode.
getFormContext()
Gets the forms context where it resides, returns a dataset of its structure to the main controller.
getFormWidth()
Gets the form width in pixels.
getMaxRecordIndex()
Returns the current cached record count of the current foundset.
getPartHeight(partType)
Gets the part height in pixels.
getPartYOffset(partType)
Returns the Y offset of a given part of the form.
getSelectedIndex()
Gets the current record index of the current foundset.
String[]
getTabSequence()
Get an array with the names of the components that are part of the tab sequence.
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.
loadAllRecords()
Loads all accessible records from the datasource into the form foundset.
loadOmittedRecords()
Loads the records that are currently omitted in the form foundset.
loadRecords([data], [queryArgumentsArray])
Load records via a (related) foundset, primary key (dataset/number/uuid) or query into the form.
omitRecord()
Omit current record in form foundset, to be shown with loadOmittedRecords.
void
print([printCurrentRecordOnly], [showPrinterSelectDialog], [printerJob])
Print this form with current foundset, without preview.
recreateUI()
Recreates the forms UI components, to reflect the latest solution model.
void
relookup()
Performs a relookup for the current foundset record dataproviders.
void
setDataProviderValue(dataprovider, value)
Sets the value based on a specified dataprovider name.
void
setDesignMode([ondrag], [ondrop], [onselect], [onresize])
Sets this form in designmode with param true or one or more methods.
void
setPageFormat(width, height, leftmargin, rightmargin, topmargin, bottommargin, [orientation], [units])
Set the page format to use when printing.
void
setPreferredPrinter(printerName)
Set the preferred printer name to use when printing.
void
setSelectedIndex(index)
Sets the current record index of the current foundset.
void
setTabSequence(arrayOfElements)
Set the tab order sequence programatically, by passing the elements references in a javascript array.
void
show([dialogName/windowName], [modal])
Shows the form (makes the form visible), optionally shown in the specified dialog (modal or not)/window.
void
showPrintPreview([printCurrentRecordOnly], [printerJob], [zoomFactor])
Show this form in print preview.
void
showRecords(data, [dialogName/windowName], [modal])
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
void
sort(sortString, [defer])
Sorts the form foundset based on the given sort string.
void
sortDialog([sortString])
Show the sort dialog to the user a preselection sortString can be passed, to sort the form foundset.
{column:padding=0px|width=100%}{column}
Property Details
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.
Since
Replace with version info
Parameters
Returns
[Boolean]
Also see
External links
Sample
//gets the enabled state of the form var state = forms.customer.controller.enabled; //enables the form for input forms.customer.controller.enabled = true;
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.
Since
Replace with version info
Parameters
Returns
[Boolean]
Also see
External links
Sample
//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
Get/Set the current type of view of this form.
Since
Replace with version info
Parameters
Returns
[Number]
Also see
External links
Sample
//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
{column:padding=0px|width=100%}{column}
Method Details
deleteAllRecords
()
Deletes all records in foundset, resulting in empty foundset.
Since
Replace with version info
Parameters
Returns
[Boolean] – false incase of related foundset having records and orphans records are not allowed by the relation
Also see
External links
Sample
var success = forms.customer.controller.deleteAllRecords();
deleteRecord
()
Delete current selected record, deletes mulitple selected records incase the foundset is using multiselect.
Since
Replace with version info
Parameters
Returns
[Boolean] – false incase of related foundset having records and orphans records are not allowed by the relation
Also see
External links
Sample
var success = forms.customer.controller.deleteRecord();
duplicateRecord
([location])
Duplicate current record or record at index in the form foundset.
Since
Replace with version info
Parameters\\\[location] – boolean true adds the new record as the topmost record, or adds at specified index
Returns
[Boolean] – true if succesful
Also see
External links
Sample
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
Start a find request, use the "search" function to perform/exit the find.
Make sure the operator and the data (value) are part of the string passed to dataprovider (included inside a pair of quotation marks).
Syntax:
<dataprovidername> = '<operator>data'
Example:
if (controller.find()) //find will fail if autosave is disabled and there are unsaved records
{
columnTextDataProvider = '=a search value';
columnNumberDataProvider = '>=10';
columnDateDataProvider = '>=10-03-2009|dd-MM-yyyy';
controller.search()
}
Since
Replace with version info
Parameters
Returns
[Boolean] – true if successful, will return false if autosave is disabled and there are unsaved records.
External links
Sample
if (forms.customer.controller.find()) //find will fail if autosave is disabled and there are unsaved records { columnTextDataProvider = '=a search value'; columnNumberDataProvider = '>10'; columnDateDataProvider = '>=10-03-2009|dd-MM-yyyy'; forms.customer.controller.search() }
void
focusField
(fieldName, skipReadonly)
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).
Since
Replace with version info
Returns
void
Also see
External links
Sample
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); }
void
focusFirstField
()
Sets focus to the first field of the form; based on tab order sequence.
Since
Replace with version info
Parameters
Returns
void
External links
Sample
forms.customer.controller.focusFirstField();
getContainerName
()
Get the name of the window/dialog this form is displayed in.
Since
Replace with version info
Parameters
Returns
[String] – the name of the window/dialog this form is displayed in. If the form is not showing in a window or dialog (other then main application frame), it returns null.
Also see
External links
Sample
var dialogOrWindowName = forms.customer.controller.getContainerName(); if (dialogOrWindowName != null) { application.closeForm(dialogOrWindowName); }
getDataProviderMaxLength
(name)
Returns the maximum length allowed in the specified dataprovider.
Since
Replace with version info
Parameters\\\{String} name – the dataprovider name
Returns
[Number] – the length
Also see
External links
Sample
forms.customer.controller.getDataProviderMaxLength('name');
getDataProviderValue
(dataProvider)
Gets a value based on the specified dataprovider name.
Since
Replace with version info
Parameters\\\{String} dataProvider – the dataprovider name to retieve the value for
Returns
[Object] – the dataprovider value (null if unknown dataprovider)
Also see
External links
Sample
var val = forms.customer.controller.getDataProviderValue('contact_name');
getDataSource
()
Get the used datasource.
Since
Replace with version info
Parameters
Returns
[String] – the datasource
Also see
External links
Sample
var dataSource = forms.customer.controller.getDataSource();
getDesignMode
()
Returns the state of this form designmode.
Since
Replace with version info
Parameters
Returns
[Boolean] – the design mode state (true/fase)
Also see
External links
Sample
var success = forms.customer.controller.getDesignMode();
getFormContext
()
Gets the forms context where it resides, returns a dataset of its structure to the main controller.
Note: can't be called in onload, because no context is yet available at this time.
Since
Replace with version info
Parameters
Returns
[JSDataSet] – the dataset with form context
External links
Sample
var dataset = forms.customer.controller.getFormContext(); if (dataset.getMaxRowIndex() > 1) { // form is in a tabpanel //dataset columns: [containername(1),formname(2),tabpanel or beanname(3),tabname(4),tabindex(5)] //dataset rows: mainform(1) -> parent(2) -> current form(3) (when 3 forms deep) var parentFormName = dataset.getValue(1,2) }
getFormWidth
()
Gets the form width in pixels.
Since
Replace with version info
Parameters
Returns
[Number] – the width in pixels
Also see
External links
Sample
var width = forms.customer.controller.getFormWidth();
getMaxRecordIndex
()
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(...)
Since
Replace with version info
Parameters
Returns
[Number] – the max record index
External links
Sample
for ( var i = 1 ; i <= forms.customer.controller.getMaxRecordIndex() ; i++ ) { forms.customer.controller.setSelectedIndex(i); //do some action per record }
getName
()
Get the name of this form.
Since
Replace with version info
Parameters
Returns
[String] – the name
Also see
External links
Sample
var formName = forms.customer.controller.getName();
getPartHeight
(partType)
Gets the part height in pixels.
Since
Replace with version info
Parameters\\\{Number} partType – The type of the part whose height will be returned.
Returns
[Number] – the part height in pixels
Also see
External links
Sample
var height = forms.customer.controller.getPartHeight(JSPart.BODY);
getPartYOffset
(partType)
Returns the Y offset of a given part of the form.
Since
Replace with version info
Parameters\\\{Number} partType – The type of the part whose Y offset will be returned.
Returns
[Number] – A number holding the Y offset of the specified form part.
Also see
External links
Sample
var offset = forms.customer.controller.getPartYOffset(JSPart.BODY);
getSelectedIndex
()
Gets the current record index of the current foundset.
Since
Replace with version info
Parameters
Returns
[Number] – the index
Also see
External links
Sample
//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);
String[]
getTabSequence
()
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.
Since
Replace with version info
Parameters
Returns
[String][] – array of names
Also see
External links
Sample
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); }
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.
Since
Replace with version info
Parameters
Returns
[Boolean] – true if successful
Also see
External links
Sample
forms.customer.controller.invertRecords();
loadAllRecords
()
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
Since
Replace with version info
Parameters
Returns
[Boolean] – true if successful
External links
Sample
forms.customer.controller.loadAllRecords();
loadOmittedRecords
()
Loads the records that are currently omitted in the form foundset.
Since
Replace with version info
Parameters
Returns
[Boolean] – true if successful
Also see
External links
Sample
forms.customer.controller.loadOmittedRecords();
loadRecords
([data], [queryArgumentsArray])
Load records via a (related) foundset, primary key (dataset/number/uuid) or query into the form.
Load records can be used in 5 different ways
1) 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
controller.loadRecords(order_to_orderdetails);
2) to load a primary key dataset, will remove related sort!
var dataset = databaseManager.getDataSetByQuery(...);
controller.loadRecords(dataset);
3) to load a single record by primary key, will remove related sort! (pk should be a number or UUID)
controller.loadRecords(123);
or
controller.loadRecords(application.getUUID('6b5e2f5d-047e-45b3-80ee-3a32267b1f20'));
4) to reload all last related records again, if for example after a search in related tabpanel
controller.loadRecords();
5) to load records in to the form based on a query (also known as 'Form by query')
controller.loadRecords(sqlstring,parameters);
limitations/requirements for sqlstring are:
-must start with 'select'
-the selected columns must be the (Servoy Form) table primary key columns (alphabetically ordered like 'select a_id, b_id,c_id ...')
-can contain '?' which are replaced with values from the array supplied to parameters argument
if the sqlstring contains an 'order by' clause, the records will be sorted accordingly and additional constraints apply:
-must contain 'from' keyword
-the 'from' must be a comma separated list of table names
-must at least select from the table used in Servoy Form
-cannot contain 'group by', 'having' or 'union'
-all columns must be fully qualified like 'orders.order_id'
Since
Replace with version info
Parameters\\\[data] – the foundset/pkdataset/singlenNmber_pk/UUIDpk/queryString to load
[queryArgumentsArray] – the arguments to replace the questions marks in the queryString
Returns
[Boolean] – true if successful
External links
Sample
//Load records can be used in 5 different ways //1) 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); //2) 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); //3) to load a single record by primary key, will remove related sort! (pk should be a number or UUID) //forms.customer.controller.loadRecords(123); //forms.customer.controller.loadRecords(application.getUUID('6b5e2f5d-047e-45b3-80ee-3a32267b1f20')); //4) to reload all last related records again, if for example after a search in related tabpanel //forms.customer.controller.loadRecords(); //5) to load records in to the form based on a query (also known as 'Form by query') //forms.customer.controller.loadRecords(sqlstring,parameters); //limitations/requirements for sqlstring are: //-must start with 'select' //-the selected columns must be the (Servoy Form) table primary key columns (alphabetically ordered like 'select a_id, b_id,c_id ...') //-can contain '?' which are replaced with values from the array supplied to parameters argument // if the sqlstring contains an 'order by' clause, the records will be sorted accordingly and additional constraints apply: //-must contain 'from' keyword //-the 'from' must be a comma separated list of table names //-must at least select from the table used in Servoy Form //-cannot contain 'group by', 'having' or 'union' //-all columns must be fully qualified like 'orders.order_id'
newRecord
([location])
Create a new record in the form foundset.
Since
Replace with version info
Parameters\\\[location] – boolean true adds the new record as the topmost record, or adds at specified index
Returns
[Boolean] – true if succesful
Also see
External links
Sample
// 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
omitRecord
()
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
Since
Replace with version info
Parameters
Returns
[Boolean] – true if successful
External links
Sample
var success = forms.customer.controller.omitRecord();
void
([printCurrentRecordOnly], [showPrinterSelectDialog], [printerJob])
Print this form with current foundset, without preview.
Since
Replace with version info
Parameters\\\[printCurrentRecordOnly] – to print the current record only
[showPrinterSelectDialog] – boolean to show the printer select dialog (default printer is normally used)
[printerJob] – print to plugin printer job, see pdf printer plugin for example
Returns
void
Also see
External links
Sample
//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'));
printXML
([printCurrentRecordOnly])
Print this form with current foundset records to xml format.
Since
Replace with version info
Parameters\\\[printCurrentRecordOnly] – to print the current record only
Returns
[String] – the XML
Also see
External links
Sample
//TIP: see also plugins.file.writeXMLFile(...) var xml = forms.customer.controller.printXML(); //print only current record //var xml = forms.customer.controller.printXML(true);
recreateUI
()
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.
Since
Replace with version info
Parameters
Returns
[Boolean] – true if successful
External links
Sample
// 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();
void
relookup
()
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.
Since
Replace with version info
Parameters
Returns
void
Also see
External links
Sample
forms.customer.controller.relookup();
search
([clearLastResults], [reduceSearch])
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.
Since
Replace with version info
Parameters\\\[clearLastResults] – boolean, clear previous search, default true
[reduceSearch] – boolean, reduce (true) or extend (false) previous search results, default true
Returns
[Number] – the recordCount
External links
Sample
var recordCount = forms.customer.controller.search(); //var recordCount = forms.customer.controller.search(false,false); //to extend foundset
void
setDataProviderValue
(dataprovider, value)
Sets the value based on a specified dataprovider name.
Since
Replace with version info
Returns
void
Also see
External links
Sample
forms.customer.controller.setDataProviderValue('contact_name','mycompany');
void
setDesignMode
([ondrag], [ondrop], [onselect], [onresize])
Sets this form in designmode with param true or one or more methods.
return to normal editmode with first parameter false.
Since
Replace with version info
Parameters\\\[ondrag] – boolean to indicate the designmode state or onDrag method reference
[ondrop] – onDrop method reference
[onselect] – onSelect method reference
[onresize] – onResize method reference
Returns
void
Also see
External links
Sample
//Set the current form in designmode with no callbacks forms.customer.controller.setDesignMode(true); //Set the current form in designmode with callbacks forms.customer.controller.setDesignMode(onDragMethod,onDropMethod,onSelectMethod,onResizeMethod); //Set the current form out of designmode (to normal browse) forms.customer.controller.setDesignMode(false);
void
setPageFormat
(width, height, leftmargin, rightmargin, topmargin, bottommargin, [orientation], [units])
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.
Since
Replace with version info
Parameters
width – the specified width of the page to be printed.
height – the specified height of the page to be printed.
leftmargin – the specified left margin of the page to be printed.
rightmargin – the specified right margin of the page to be printed.
topmargin – the specified top margin of the page to be printed.
bottommargin – the specified bottom margin of the page to be printed.
[orientation] – the specified orientation of the page to be printed; the default is Portrait mode
[units] – the specified units for the width and height of the page to be printed; the default is pixels
Returns
void
Also see
External links
Sample
//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 mm in landscape mode forms.customer.controller.setPageFormat(100, 200, 0, 0, 0, 0, 0, 0); //Set page format to a custom size of 100x200 inch in portrait mode forms.customer.controller.setPageFormat(100, 200, 0, 0, 0, 0, 1, 1);
void
setPreferredPrinter
(printerName)
Set the preferred printer name to use when printing.
Since
Replace with version info
Parameters\\\{String} printerName – The name of the printer to be used when printing.
Returns
void
Also see
External links
Sample
forms.customer.controller.setPreferredPrinter('HP Laser 2200');
void
setSelectedIndex
(index)
Sets the current record index of the current foundset.
Since
Replace with version info
Parameters\\\{Number} index – the index to select
Returns
void
Also see
External links
Sample
//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);
void
setTabSequence
(arrayOfElements)
Set the tab order sequence programatically, by passing the elements references in a javascript array.
Since
Replace with version info
Parameters\\\{Object[]} arrayOfElements – array containing the element references
Returns
void
Also see
External links
Sample
forms.customer.controller.setTabSequence([forms.customer.elements.fld_order_id, forms.customer.elements.fld_order_amount]);
void
show
([dialogName/windowName], [modal])
Shows the form (makes the form visible), optionally shown in the specified dialog (modal or not)/window.
This function does not affect the form foundset in any way.
Since
Replace with version info
Parameters\\\[dialogName/windowName] – the dialog/window name
[modal] – boolean indicating modality for dialogs or null if it should use a window; default value is false.
Returns
void
Also see
External links
Sample
//show the form in the current window/dialog forms.customer.controller.show(); //show the form in the named modal dialog //forms.customer.controller.show('mydialog',true); //show the form in a named window //forms.customer.controller.show('mywindow',null);
void
showPrintPreview
([printCurrentRecordOnly], [printerJob], [zoomFactor])
Show this form in print preview.
Since
Replace with version info
Parameters\\\[printCurrentRecordOnly] – to print the current record only
[printerJob] – print to plugin printer job, see pdf printer plugin for example (incase print is used from printpreview)
[zoomFactor] – a specified number value from 10-400
Returns
void
Also see
External links
Sample
//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);
void
showRecords
(data, [dialogName/windowName], [modal])
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.
Since
Replace with version info
Parameters
data – the foundset/pkdataset/singlenNmber_pk/UUIDpk to load before showing the form
[dialogName/windowName] – the dialog/window name
[modal] – boolean indicating modality for dialogs or null if it should use a window; default value is false
Returns
void
External links
Sample
forms.customer.controller.showRecords(foundset); //show the form in the named modal dialog //forms.customer.controller.show(foundset, 'mydialog', true); //show the form in the named window //forms.customer.controller.show(foundset, 'mywindow', null);
void
sort
(sortString, [defer])
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.
Since
Replace with version info
Parameters
sortString – the specified columns (and sort order)
[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).
Returns
void
Also see
External links
Sample
forms.customer.controller.sort('columnA desc,columnB asc');
void
sortDialog
([sortString])
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.
Since
Replace with version info
Parameters\\\[sortString] – the specified columns (and sort order)
Returns
void
Also see
External links
Sample
forms.customer.controller.sortDialog('columnA desc,columnB asc');