Deletes all records in foundset, resulting in empty foundset. |
|
|
Returns Boolean - false incase of related foundset having records and orphans records are not allowed by the relation |
|
|
Sample var success = forms.customer.controller.deleteAllRecords(); |
|
|
|
|
Delete current selected record, deletes mulitple selected records incase the foundset is using multiselect. |
|
|
Returns Boolean - false incase of related foundset having records and orphans records are not allowed by the relation |
|
|
Sample var success = forms.customer.controller.deleteRecord(); |
|
|
|
|
Duplicate current record or record at index in the form foundset. |
|
|
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 |
|
|
|
|
Duplicate current record or record at index in the form foundset. |
|
|
Parameters {Boolean} location - true adds the new record as the topmost record |
|
|
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 |
|
|
|
|
Duplicate current record or record at index in the form foundset. |
|
|
Parameters {Number} location - adds at specified index |
|
|
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 |
|
|
|
|
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 = '31-12-2010|dd-MM-yyyy'
forms.customer.controller.search()
} |
|
|
|
|
(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). |
|
|
Parameters {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 |
|
|
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);
} |
|
|
|
|
Sets focus to the first field of the form; based on tab order sequence. |
|
|
Sample forms.customer.controller.focusFirstField(); |
|
|
|
|
Returns the maximum length allowed in the specified dataprovider. |
|
|
Parameters {String} name - the dataprovider name |
|
|
Sample forms.customer.controller.getDataProviderMaxLength('name'); |
|
|
|
|
Gets a value based on the specified dataprovider name. |
|
|
Parameters {String} dataProvider - the dataprovider name to retieve the value for |
|
|
Returns Object - the dataprovider value (null if unknown dataprovider) |
|
|
Sample var val = forms.customer.controller.getDataProviderValue('contact_name'); |
|
|
|
|
Sample var dataSource = forms.customer.controller.getDataSource(); |
|
|
|
|
Returns the state of this form designmode. |
|
|
Returns Boolean - the design mode state (true/fase) |
|
|
Sample var success = forms.customer.controller.getDesignMode(); |
|
|
|
|
Get a design-time property of a form. |
|
|
Sample var prop = forms.orders.controller.getDesignTimeProperty('myprop') |
|
|
|
|
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. |
|
|
Sample //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)
} |
|
|
|
|
Gets the form width in pixels. |
|
|
Sample var width = forms.customer.controller.getFormWidth(); |
|
|
|
|
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(...) |
|
|
Sample for ( var i = 1 ; i <= forms.customer.controller.getMaxRecordIndex() ; i++ )
{
forms.customer.controller.setSelectedIndex(i);
//do some action per record
} |
|
|
|
|
Get the name of this form. |
|
|
Sample var formName = forms.customer.controller.getName(); |
|
|
|
|
Gets the part height in pixels. |
|
|
Parameters {Number} partType - The type of the part whose height will be returned. |
|
|
Returns Number - the part height in pixels |
|
|
Sample var height = forms.customer.controller.getPartHeight(JSPart.BODY); |
|
|
|
|
Returns the Y offset of a given part of the form. |
|
|
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. |
|
|
Sample var offset = forms.customer.controller.getPartYOffset(JSPart.BODY); |
|
|
|
|
Gets the current record index of the current foundset. |
|
|
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); |
|
|
|
|
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. |
|
|
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);
} |
|
|
|
|
Returns the JSWindow that the form is shown in, or null if the form is not currently showing in a window. |
|
|
Returns JSWindow - the JSWindow that the form is shown in, or null if the form is not currently showing in a window. |
|
|
Sample 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);
} |
|
|
|
|
Inverts the current foundset against all rows of the current table; all records that are not in the foundset will become the current foundset. |
|
|
Sample forms.customer.controller.invertRecords(); |
|
|
|
|
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 |
|
|
Sample forms.customer.controller.loadAllRecords(); |
|
|
|
|
Loads the records that are currently omitted in the form foundset. |
|
|
Sample forms.customer.controller.loadOmittedRecords(); |
|
|
|
|
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. |
|
|
Sample //to reload all last (related) records again, if for example after a search in related tabpanel
forms.customer.controller.loadRecords(); |
|
|
|
|
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. |
|
|
Sample //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); |
|
|
|
|
Loads a primary key dataset, will remove related sort. |
|
|
Sample //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); |
|
|
|
|
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(). |
|
|
Sample forms.customer.controller.loadRecords(application.getUUID('6b5e2f5d-047e-45b3-80ee-3a32267b1f20')); |
|
|
|
|
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(). |
|
|
Parameters {Number} singlenNmber_pk - to load |
|
|
Sample forms.customer.controller.loadRecords(123); |
|
|
|
|
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). |
|
|
Parameters {String} queryString - to load |
|
|
Sample forms.customer.controller.loadRecords(sqlstring); |
|
|
|
|
(queryString, queryArgumentsArray) |
|
|
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). |
|
|
Parameters {String} queryString - to load {Object[]} queryArgumentsArray - the arguments to replace the questions marks in the queryString |
|
|
Sample forms.customer.controller.loadRecords(sqlstring,parameters); |
|
|
|
|
Create a new record in the form foundset. |
|
|
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 |
|
|
|
|
Create a new record in the form foundset. |
|
|
Parameters {Boolean} insertOnTop - true adds the new record as the topmost record |
|
|
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 |
|
|
|
|
Create a new record in the form foundset. |
|
|
Parameters {Number} location - adds at specified index |
|
|
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 |
|
|
|
|
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 |
|
|
Sample var success = forms.customer.controller.omitRecord(); |
|
|
|
|
Print this form with current foundset, without preview. |
|
|
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')); |
|
|
|
|
Print this form with current foundset, without preview. |
|
|
Parameters {Boolean} printCurrentRecordOnly - to print the current record only |
|
|
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')); |
|
|
|
|
(printCurrentRecordOnly, showPrinterSelectDialog) |
|
|
Print this form with current foundset, without preview. |
|
|
Parameters {Boolean} printCurrentRecordOnly - to print the current record only {Boolean} showPrinterSelectDialog - to show the printer select dialog (default printer is normally used) |
|
|
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')); |
|
|
|
|
(printCurrentRecordOnly, showPrinterSelectDialog, printerJob) |
|
|
Print this form with current foundset, without preview. |
|
|
Parameters {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 |
|
|
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')); |
|
|
|
|
Print this form with current foundset records to xml format. |
|
|
Sample //TIP: see also plugins.file.writeXMLFile(...)
var xml = forms.customer.controller.printXML();
//print only current record
//var xml = forms.customer.controller.printXML(true); |
|
|
|
|
Print this form with current foundset records to xml format. |
|
|
Parameters {Boolean} printCurrentRecordOnly - to print the current record only |
|
|
Sample //TIP: see also plugins.file.writeXMLFile(...)
var xml = forms.customer.controller.printXML();
//print only current record
//var xml = forms.customer.controller.printXML(true); |
|
|
|
|
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. |
|
|
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(); |
|
|
|
|
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. |
|
|
Sample forms.customer.controller.relookup(); |
|
|
|
|
Sample var recordCount = forms.customer.controller.search();
//var recordCount = forms.customer.controller.search(false,false); //to extend foundset |
|
|
|
|
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. |
|
|
Parameters {Boolean} clearLastResults - boolean, clear previous search, default true |
|
|
Sample var recordCount = forms.customer.foundset.search();
//var recordCount = forms.customer.foundset.search(false,false); //to extend foundset |
|
|
|
|
(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. |
|
|
Parameters {Boolean} clearLastResults - boolean, clear previous search, default true {Boolean} reduceSearch - boolean, reduce (true) or extend (false) previous search results, default true |
|
|
Sample var recordCount = forms.customer.foundset.search();
//var recordCount = forms.customer.foundset.search(false,false); //to extend foundset |
|
|
|
|
Sets the value based on a specified dataprovider name. |
|
|
Parameters {String} dataprovider - the dataprovider name to set the value for {Object} value - the value to set in the dataprovider |
|
|
Sample forms.customer.controller.setDataProviderValue('contact_name','mycompany'); |
|
|
|
|
Sets this form in designmode with param true, false will return to normal browse/edit mode. |
|
|
Parameters {Boolean} designMode - sets form in design mode if true, false ends design mode. |
|
|
Sample 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); |
|
|
|
|
Sets this form in designmode with one or more callback methods. |
|
|
Parameters {Function} ondrag - onDrag method reference |
|
|
Sample 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); |
|
|
|
|
Sets this form in designmode with one or more callback methods. |
|
|
Parameters {Function} ondrag - onDrag method reference {Function} ondrop - onDrop method reference |
|
|
Sample 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); |
|
|
|
|
(ondrag, ondrop, onselect) |
|
|
Sets this form in designmode with one or more callback methods. |
|
|
Parameters {Function} ondrag - onDrag method reference {Function} ondrop - onDrop method reference {Function} onselect - onSelect method reference |
|
|
Sample 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); |
|
|
|
|
(ondrag, ondrop, onselect, onresize) |
|
|
Sets this form in designmode with one or more callback methods. |
|
|
Parameters {Function} ondrag - onDrag method reference {Function} ondrop - onDrop method reference {Function} onselect - onSelect method reference {Function} onresize - onResize method reference |
|
|
Sample 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); |
|
|
|
|
(ondrag, ondrop, onselect, onresize, ondblclick) |
|
|
Sets this form in designmode with one or more callback methods. |
|
|
Parameters {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 |
|
|
Sample 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); |
|
|
|
|
(ondrag, ondrop, onselect, onresize, ondblclick, onrightclick) |
|
|
Sets this form in designmode with one or more callback methods. |
|
|
Parameters {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 |
|
|
Sample 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); |
|
|
|
|
(width, height, leftmargin, rightmargin, topmargin, bottommargin) |
|
|
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. |
|
|
Parameters {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. |
|
|
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 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); |
|
|
|
|
(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation) |
|
|
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. |
|
|
Parameters {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 |
|
|
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 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); |
|
|
|
|
(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. |
|
|
Parameters {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 |
|
|
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 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); |
|
|
|
|
Set the preferred printer name to use when printing. |
|
|
Parameters {String} printerName - The name of the printer to be used when printing. |
|
|
Sample forms.customer.controller.setPreferredPrinter('HP Laser 2200'); |
|
|
|
|
Sets the current record index of the current foundset. |
|
|
Parameters {Number} index - the index to select |
|
|
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); |
|
|
|
|
Set the tab order sequence programatically, by passing the elements references in a javascript array. |
|
|
Parameters {Object[]} arrayOfElements - array containing the element references |
|
|
Sample forms.customer.controller.setTabSequence([forms.customer.elements.fld_order_id, forms.customer.elements.fld_order_amount]); |
|
|
|
|
Shows the form (makes the form visible) This function does not affect the form foundset in any way. |
|
|
Sample // 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); |
|
|
|
|
Shows the form (makes the form visible) This function does not affect the form foundset in any way. |
|
|
Parameters {JSWindow} window - the window in which this form should be shown, given as a window object |
|
|
Sample // 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); |
|
|
|
|
Shows the form (makes the form visible) This function does not affect the form foundset in any way. |
|
|
Parameters {String} window - the window in which this form should be shown, specified by the name of an existing window |
|
|
Sample // 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); |
|
|
|
|
Show this form in print preview. |
|
|
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); |
|
|
|
|
Show this form in print preview. |
|
|
Parameters {Boolean} printCurrentRecordOnly - to print the current record only |
|
|
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); |
|
|
|
|
(printCurrentRecordOnly, printerJob) |
|
|
Show this form in print preview. |
|
|
Parameters {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) |
|
|
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); |
|
|
|
|
(printCurrentRecordOnly, printerJob, zoomFactor) |
|
|
Show this form in print preview. |
|
|
Parameters {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 |
|
|
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); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {JSFoundSet} foundset - the foundset to load before showing the form. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {JSDataSet} pkdataset - the pkdataset to load before showing the form. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {QBSelect} query - the query to load before showing the form. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {UUID} UUIDpk - the UUIDpk to load before showing the form. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {Number} singleNumber_pk - the singleNumber_pk to load before showing the form. |
|
|
Sample 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"); |
|
|
|
|
(singleNumber_pk, window) |
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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 |
|
|
Sample 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"); |
|
|
|
|
(singleNumber_pk, window) |
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {String} query - the query to load before showing the form. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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 |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {String} query - the query to load before showing the form. {Object[]} argumentsArray - the array of arguments for the query |
|
|
Sample 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"); |
|
|
|
|
(query, argumentsArray, window) |
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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 |
|
|
Sample 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"); |
|
|
|
|
(query, argumentsArray, window) |
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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. |
|
|
Sample 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"); |
|
|
|
|
Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'. |
|
|
Parameters {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. |
|
|
Sample 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"); |
|
|
|
|
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. |
|
|
Parameters {String} sortString - the specified columns (and sort order) |
|
|
Sample forms.customer.controller.sort('columnA desc,columnB asc'); |
|
|
|
|
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. |
|
|
Parameters {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). |
|
|
Sample forms.customer.controller.sort('columnA desc,columnB asc'); |
|
|
|
|
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. |
|
|
Sample forms.customer.controller.sortDialog('columnA desc,columnB asc'); |
|
|
|
|
Parameters {String} sortString - the specified columns (and sort order) |
|
|
Sample forms.customer.controller.sortDialog('columnA desc,columnB asc'); |
|
|
|
|
|