{div:style=display:none} DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING. THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR{div} {div:id=description}{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#enabled] Gets or sets the enabled state of a form; also known as "grayed\-out".{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#view] Get/Set the current type of view of this form.{td}{tr}{tbody}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#deleteAllRecords]\() Deletes all records in foundset, resulting in empty foundset.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#deleteRecord]\() Delete current selected record, deletes mulitple selected records incase the foundset is using multiselect.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#duplicateRecord]\() Duplicate current record or record at index in the form foundset.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#duplicateRecord]\(location) Duplicate current record or record at index in the form foundset.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#duplicateRecord]\(location) Duplicate current record or record at index in the form foundset.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#find]\(){td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#focusField]\(fieldName, skipReadonly) Sets focus to a field specified by its name.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#focusFirstField]\() Sets focus to the first field of the form; based on tab order sequence.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getDataProviderMaxLength]\(name) Returns the maximum length allowed in the specified dataprovider.{td}{tr}{tbody}{tbody}{tr}{td}[Object]{td}{td}[#getDataProviderValue]\(dataProvider) Gets a value based on the specified dataprovider name.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getDataSource]\() Get the used datasource.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#getDesignMode]\() Returns the state of this form designmode.{td}{tr}{tbody}{tbody}{tr}{td}[Object]{td}{td}[#getDesignTimeProperty]\() Get a design\-time property of a form.{td}{tr}{tbody}{tbody}{tr}{td}[JSDataSet]{td}{td}[#getFormContext]\() Gets the forms context where it resides, returns a dataset of its structure to the main controller.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getFormWidth]\() Gets the form width in pixels.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getMaxRecordIndex]\() Returns the current cached record count of the current foundset.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getName]\() Get the name of this form.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getPartHeight]\(partType) Gets the part height in pixels.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getPartYOffset]\(partType) Returns the Y offset of a given part of the form.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getSelectedIndex]\() Gets the current record index of the current foundset.{td}{tr}{tbody}{tbody}{tr}{td}[String]\[]{td}{td}[#getTabSequence]\() Get an array with the names of the components that are part of the tab sequence.{td}{tr}{tbody}{tbody}{tr}{td}[JSWindow]{td}{td}[#getWindow]\() Returns the JSWindow that the form is shown in, or null if the form is not currently showing in a window.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#loadAllRecords]\() Loads all accessible records from the datasource into the form foundset.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#loadOmittedRecords]\() Loads the records that are currently omitted in the form foundset.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#loadRecords]\() Loads all accessible records from the datasource into the form foundset.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#loadRecords]\(foundset) Loads a (related) foundset into the form.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#loadRecords]\(pkdataset) Loads a primary key dataset, will remove related sort.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#loadRecords]\(UUIDpk) Loads a single record by primary key, will remove related sort.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#loadRecords]\(singlenNmber_pk) Loads a single record by primary key, will remove related sort.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#loadRecords]\(queryString) Loads records into form foundset based on a query (also known as 'Form by query').{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#loadRecords]\(queryString, queryArgumentsArray) Loads records into form foundset based on a query (also known as 'Form by query').{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#newRecord]\() Create a new record in the form foundset.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#newRecord]\(insertOnTop) Create a new record in the form foundset.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#newRecord]\(location) Create a new record in the form foundset.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#omitRecord]\() Omit current record in form foundset, to be shown with loadOmittedRecords.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#print]\() Print this form with current foundset, without preview.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#print]\(printCurrentRecordOnly) Print this form with current foundset, without preview.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#print]\(printCurrentRecordOnly, showPrinterSelectDialog) Print this form with current foundset, without preview.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#print]\(printCurrentRecordOnly, showPrinterSelectDialog, printerJob) Print this form with current foundset, without preview.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#printXML]\() Print this form with current foundset records to xml format.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#printXML]\(printCurrentRecordOnly) Print this form with current foundset records to xml format.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#recreateUI]\() Recreates the forms UI components, to reflect the latest solution model.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#relookup]\() Performs a relookup for the current foundset record dataproviders.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#search]\(){td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#search]\(clearLastResults) Start the database search and use the results, returns the number of records, make sure you did "find" function first.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#search]\(clearLastResults, reduceSearch) Start the database search and use the results, returns the number of records, make sure you did "find" function first.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setDataProviderValue]\(dataprovider, value) Sets the value based on a specified dataprovider name.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setDesignMode]\(designMode) Sets this form in designmode with param true, false will return to normal browse/edit mode.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setDesignMode]\(ondrag) Sets this form in designmode with one or more callback methods.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setDesignMode]\(ondrag, ondrop) Sets this form in designmode with one or more callback methods.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setDesignMode]\(ondrag, ondrop, onselect) Sets this form in designmode with one or more callback methods.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setDesignMode]\(ondrag, ondrop, onselect, onresize) Sets this form in designmode with one or more callback methods.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setDesignMode]\(ondrag, ondrop, onselect, onresize, ondblclick) Sets this form in designmode with one or more callback methods.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setDesignMode]\(ondrag, ondrop, onselect, onresize, ondblclick, onrightclick) Sets this form in designmode with one or more callback methods.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setPageFormat]\(width, height, leftmargin, rightmargin, topmargin, bottommargin) Set the page format to use when printing.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setPageFormat]\(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation) Set the page format to use when printing.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setPageFormat]\(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation, units) Set the page format to use when printing.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setPreferredPrinter]\(printerName) Set the preferred printer name to use when printing.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setSelectedIndex]\(index) Sets the current record index of the current foundset.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setTabSequence]\(arrayOfElements) Set the tab order sequence programatically, by passing the elements references in a javascript array.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#show]\() Shows the form (makes the form visible) This function does not affect the form foundset in any way.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#show]\(window) Shows the form (makes the form visible) This function does not affect the form foundset in any way.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#show]\(window) Shows the form (makes the form visible) This function does not affect the form foundset in any way.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showPrintPreview]\() Show this form in print preview.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showPrintPreview]\(printCurrentRecordOnly) Show this form in print preview.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showPrintPreview]\(printCurrentRecordOnly, printerJob) Show this form in print preview.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showPrintPreview]\(printCurrentRecordOnly, printerJob, zoomFactor) Show this form in print preview.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(foundset) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(foundset, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(foundset, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(pkdataset) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(pkdataset, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(pkdataset, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(query) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(query, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(query, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(UUIDpk) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(UUIDpk, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(UUIDpk, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(singleNumber_pk) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(singleNumber_pk, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(singleNumber_pk, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(query) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(query, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(query, argumentsArray) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(query, argumentsArray, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(query, argumentsArray, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#showRecords]\(query, window) Load data into the form and shows the form, is a shortcut for the functions 'loadRecords' and 'show'.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#sort]\(sortString) Sorts the form foundset based on the given sort string.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#sort]\(sortString, defer) Sorts the form foundset based on the given sort string.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#sortDialog]\() Show the sort dialog to the user a preselection sortString can be passed, to sort the form foundset.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#sortDialog]\(sortString){td}{tr}{tbody}{table}\\ {table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=enabled}{tr:id=name}{td}h6.enabled{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //gets the enabled state of the form var state = forms.customer.controller.enabled; //enables the form for input forms.customer.controller.enabled = true; {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=readOnly}{tr:id=name}{td}h6.readOnly{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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 {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=view}{tr:id=name}{td}h6.view{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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 {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=deleteAllRecords}{tr:id=name}{td}h6.deleteAllRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}deleteAllRecords{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- false incase of related foundset having records and orphans records are not allowed by the relation{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var success = forms.customer.controller.deleteAllRecords(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=deleteRecord}{tr:id=name}{td}h6.deleteRecord{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}deleteRecord{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- false incase of related foundset having records and orphans records are not allowed by the relation{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var success = forms.customer.controller.deleteRecord(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=duplicateRecord}{tr:id=name}{td}h6.duplicateRecord{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}duplicateRecord{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if succesful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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 {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=duplicateRecord-Boolean}{tr:id=name}{td}h6.duplicateRecord{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}duplicateRecord{span}{span}\(location){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} location -- true adds the new record as the topmost record {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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 {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=duplicateRecord-Number}{tr:id=name}{td}h6.duplicateRecord{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}duplicateRecord{span}{span}\(location){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} location -- adds at specified index {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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 {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=find}{tr:id=name}{td}h6.find{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}find{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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() } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=focusField-String_Boolean}{tr:id=name}{td}h6.focusField{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}focusField{span}{span}\(fieldName, skipReadonly){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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 {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=focusFirstField}{tr:id=name}{td}h6.focusFirstField{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}focusFirstField{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.focusFirstField(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDataProviderMaxLength-String}{tr:id=name}{td}h6.getDataProviderMaxLength{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getDataProviderMaxLength{span}{span}\(name){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} name -- the dataprovider name {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- the length{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.getDataProviderMaxLength('name'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDataProviderValue-String}{tr:id=name}{td}h6.getDataProviderValue{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Object]{span}{span:style=font-weight: bold;}getDataProviderValue{span}{span}\(dataProvider){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dataProvider -- the dataprovider name to retieve the value for {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Object] -- the dataprovider value (null if unknown dataprovider){div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var val = forms.customer.controller.getDataProviderValue('contact_name'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDataSource}{tr:id=name}{td}h6.getDataSource{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getDataSource{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- the datasource{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var dataSource = forms.customer.controller.getDataSource(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDesignMode}{tr:id=name}{td}h6.getDesignMode{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}getDesignMode{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- the design mode state (true/fase){div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var success = forms.customer.controller.getDesignMode(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDesignTimeProperty}{tr:id=name}{td}h6.getDesignTimeProperty{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Object]{span}{span:style=font-weight: bold;}getDesignTimeProperty{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Object]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var prop = forms.orders.controller.getDesignTimeProperty('myprop') {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getFormContext}{tr:id=name}{td}h6.getFormContext{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSDataSet]{span}{span:style=font-weight: bold;}getFormContext{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSDataSet] -- the dataset with form context{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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) } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getFormWidth}{tr:id=name}{td}h6.getFormWidth{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getFormWidth{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- the width in pixels{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var width = forms.customer.controller.getFormWidth(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getMaxRecordIndex}{tr:id=name}{td}h6.getMaxRecordIndex{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getMaxRecordIndex{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- the max record index{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} for ( var i = 1 ; i <= forms.customer.controller.getMaxRecordIndex() ; i++ ) { forms.customer.controller.setSelectedIndex(i); //do some action per record } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getName}{tr:id=name}{td}h6.getName{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getName{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- the name{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var formName = forms.customer.controller.getName(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getPartHeight-Number}{tr:id=name}{td}h6.getPartHeight{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getPartHeight{span}{span}\(partType){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} partType -- The type of the part whose height will be returned. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- the part height in pixels{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var height = forms.customer.controller.getPartHeight(JSPart.BODY); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getPartYOffset-Number}{tr:id=name}{td}h6.getPartYOffset{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getPartYOffset{span}{span}\(partType){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} partType -- The type of the part whose Y offset will be returned. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- A number holding the Y offset of the specified form part.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var offset = forms.customer.controller.getPartYOffset(JSPart.BODY); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSelectedIndex}{tr:id=name}{td}h6.getSelectedIndex{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getSelectedIndex{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- the index{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTabSequence}{tr:id=name}{td}h6.getTabSequence{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]\[]{span}{span:style=font-weight: bold;}getTabSequence{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[] -- array of names{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getWindow}{tr:id=name}{td}h6.getWindow{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSWindow]{span}{span:style=font-weight: bold;}getWindow{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSWindow] -- the JSWindow that the form is shown in, or null if the form is not currently showing in a window.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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); } {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=invertRecords}{tr:id=name}{td}h6.invertRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}invertRecords{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.invertRecords(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loadAllRecords}{tr:id=name}{td}h6.loadAllRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}loadAllRecords{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.loadAllRecords(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loadOmittedRecords}{tr:id=name}{td}h6.loadOmittedRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}loadOmittedRecords{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.loadOmittedRecords(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loadRecords}{tr:id=name}{td}h6.loadRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}loadRecords{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //to reload all last (related) records again, if for example after a search in related tabpanel forms.customer.controller.loadRecords(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loadRecords-JSFoundSet}{tr:id=name}{td}h6.loadRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}loadRecords{span}{span}\(foundset){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSFoundSet]} foundset -- to load {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loadRecords-JSDataSet}{tr:id=name}{td}h6.loadRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}loadRecords{span}{span}\(pkdataset){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSDataSet]} pkdataset -- to load {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loadRecords-UUID}{tr:id=name}{td}h6.loadRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}loadRecords{span}{span}\(UUIDpk){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[UUID]} UUIDpk -- to load {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.loadRecords(application.getUUID('6b5e2f5d-047e-45b3-80ee-3a32267b1f20')); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loadRecords-Number}{tr:id=name}{td}h6.loadRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}loadRecords{span}{span}\(singlenNmber_pk){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} singlenNmber_pk -- to load {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.loadRecords(123); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loadRecords-String}{tr:id=name}{td}h6.loadRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}loadRecords{span}{span}\(queryString){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} queryString -- to load {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.loadRecords(sqlstring); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=loadRecords-String_ObjectArray}{tr:id=name}{td}h6.loadRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}loadRecords{span}{span}\(queryString, queryArgumentsArray){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} queryString -- to load \{[Object]\[]} queryArgumentsArray -- the arguments to replace the questions marks in the queryString {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.loadRecords(sqlstring,parameters); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=newRecord}{tr:id=name}{td}h6.newRecord{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}newRecord{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if succesful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // 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 {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=newRecord-Boolean}{tr:id=name}{td}h6.newRecord{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}newRecord{span}{span}\(insertOnTop){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} insertOnTop -- true adds the new record as the topmost record {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // 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 {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=newRecord-Number}{tr:id=name}{td}h6.newRecord{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}newRecord{span}{span}\(location){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} location -- adds at specified index {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // 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 {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=omitRecord}{tr:id=name}{td}h6.omitRecord{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}omitRecord{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var success = forms.customer.controller.omitRecord(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=print}{tr:id=name}{td}h6.print{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}print{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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')); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=print-Boolean}{tr:id=name}{td}h6.print{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}print{span}{span}\(printCurrentRecordOnly){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} printCurrentRecordOnly -- to print the current record only {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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')); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=print-Boolean_Boolean}{tr:id=name}{td}h6.print{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}print{span}{span}\(printCurrentRecordOnly, showPrinterSelectDialog){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} printCurrentRecordOnly -- to print the current record only \{[Boolean]} showPrinterSelectDialog -- to show the printer select dialog (default printer is normally used) {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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')); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=print-Boolean_Boolean_PrinterJob}{tr:id=name}{td}h6.print{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}print{span}{span}\(printCurrentRecordOnly, showPrinterSelectDialog, printerJob){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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 {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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')); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=printXML}{tr:id=name}{td}h6.printXML{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}printXML{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- the XML{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //TIP: see also plugins.file.writeXMLFile(...) var xml = forms.customer.controller.printXML(); //print only current record //var xml = forms.customer.controller.printXML(true); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=printXML-Boolean}{tr:id=name}{td}h6.printXML{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}printXML{span}{span}\(printCurrentRecordOnly){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} printCurrentRecordOnly -- to print the current record only {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- the XML{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //TIP: see also plugins.file.writeXMLFile(...) var xml = forms.customer.controller.printXML(); //print only current record //var xml = forms.customer.controller.printXML(true); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=recreateUI}{tr:id=name}{td}h6.recreateUI{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Boolean]{span}{span:style=font-weight: bold;}recreateUI{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- true if successful{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // 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(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=relookup}{tr:id=name}{td}h6.relookup{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}relookup{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.relookup(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=search}{tr:id=name}{td}h6.search{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}search{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var recordCount = forms.customer.controller.search(); //var recordCount = forms.customer.controller.search(false,false); //to extend foundset {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=search-Boolean}{tr:id=name}{td}h6.search{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}search{span}{span}\(clearLastResults){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} clearLastResults -- boolean, clear previous search, default true {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- the recordCount{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var recordCount = forms.customer.foundset.search(); //var recordCount = forms.customer.foundset.search(false,false); //to extend foundset {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=search-Boolean_Boolean}{tr:id=name}{td}h6.search{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}search{span}{span}\(clearLastResults, reduceSearch){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} clearLastResults -- boolean, clear previous search, default true \{[Boolean]} reduceSearch -- boolean, reduce (true) or extend (false) previous search results, default true {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- the recordCount{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var recordCount = forms.customer.foundset.search(); //var recordCount = forms.customer.foundset.search(false,false); //to extend foundset {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setDataProviderValue-String_Object}{tr:id=name}{td}h6.setDataProviderValue{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setDataProviderValue{span}{span}\(dataprovider, value){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} dataprovider -- the dataprovider name to set the value for \{[Object]} value -- the value to set in the dataprovider {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.setDataProviderValue('contact_name','mycompany'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setDesignMode-Boolean}{tr:id=name}{td}h6.setDesignMode{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setDesignMode{span}{span}\(designMode){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} designMode -- sets form in design mode if true, false ends design mode. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setDesignMode-Function}{tr:id=name}{td}h6.setDesignMode{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setDesignMode{span}{span}\(ondrag){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} ondrag -- onDrag method reference {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setDesignMode-Function_Function}{tr:id=name}{td}h6.setDesignMode{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setDesignMode{span}{span}\(ondrag, ondrop){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} ondrag -- onDrag method reference \{[Function]} ondrop -- onDrop method reference {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setDesignMode-Function_Function_Function}{tr:id=name}{td}h6.setDesignMode{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setDesignMode{span}{span}\(ondrag, ondrop, onselect){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} ondrag -- onDrag method reference \{[Function]} ondrop -- onDrop method reference \{[Function]} onselect -- onSelect method reference {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setDesignMode-Function_Function_Function_Function}{tr:id=name}{td}h6.setDesignMode{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setDesignMode{span}{span}\(ondrag, ondrop, onselect, onresize){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Function]} ondrag -- onDrag method reference \{[Function]} ondrop -- onDrop method reference \{[Function]} onselect -- onSelect method reference \{[Function]} onresize -- onResize method reference {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setDesignMode-Function_Function_Function_Function_Function}{tr:id=name}{td}h6.setDesignMode{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setDesignMode{span}{span}\(ondrag, ondrop, onselect, onresize, ondblclick){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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 {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setDesignMode-Function_Function_Function_Function_Function_Function}{tr:id=name}{td}h6.setDesignMode{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setDesignMode{span}{span}\(ondrag, ondrop, onselect, onresize, ondblclick, onrightclick){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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 {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setPageFormat-Number_Number_Number_Number_Number_Number}{tr:id=name}{td}h6.setPageFormat{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setPageFormat{span}{span}\(width, height, leftmargin, rightmargin, topmargin, bottommargin){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setPageFormat-Number_Number_Number_Number_Number_Number_Number}{tr:id=name}{td}h6.setPageFormat{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setPageFormat{span}{span}\(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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 {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setPageFormat-Number_Number_Number_Number_Number_Number_Number_Number}{tr:id=name}{td}h6.setPageFormat{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setPageFormat{span}{span}\(width, height, leftmargin, rightmargin, topmargin, bottommargin, orientation, units){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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 {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setPreferredPrinter-String}{tr:id=name}{td}h6.setPreferredPrinter{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setPreferredPrinter{span}{span}\(printerName){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} printerName -- The name of the printer to be used when printing. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.setPreferredPrinter('HP Laser 2200'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setSelectedIndex-Number}{tr:id=name}{td}h6.setSelectedIndex{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setSelectedIndex{span}{span}\(index){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} index -- the index to select {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setTabSequence-ObjectArray}{tr:id=name}{td}h6.setTabSequence{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setTabSequence{span}{span}\(arrayOfElements){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Object]\[]} arrayOfElements -- array containing the element references {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.setTabSequence([forms.customer.elements.fld_order_id, forms.customer.elements.fld_order_amount]); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=show}{tr:id=name}{td}h6.show{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}show{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=show-JSWindow}{tr:id=name}{td}h6.show{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}show{span}{span}\(window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSWindow]} window -- the window in which this form should be shown, given as a window object {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=show-String}{tr:id=name}{td}h6.show{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}show{span}{span}\(window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} window -- the window in which this form should be shown, specified by the name of an existing window {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} // 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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showPrintPreview}{tr:id=name}{td}h6.showPrintPreview{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showPrintPreview{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showPrintPreview-Boolean}{tr:id=name}{td}h6.showPrintPreview{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showPrintPreview{span}{span}\(printCurrentRecordOnly){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Boolean]} printCurrentRecordOnly -- to print the current record only {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showPrintPreview-Boolean_PrinterJob}{tr:id=name}{td}h6.showPrintPreview{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showPrintPreview{span}{span}\(printCurrentRecordOnly, printerJob){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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) {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showPrintPreview-Boolean_PrinterJob_Number}{tr:id=name}{td}h6.showPrintPreview{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showPrintPreview{span}{span}\(printCurrentRecordOnly, printerJob, zoomFactor){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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 {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} //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); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-JSFoundSet}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(foundset){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSFoundSet]} foundset -- the foundset to load before showing the form. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-JSFoundSet_JSWindow}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(foundset, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-JSFoundSet_String}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(foundset, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-JSDataSet}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(pkdataset){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[JSDataSet]} pkdataset -- the pkdataset to load before showing the form. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-JSDataSet_JSWindow}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(pkdataset, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-JSDataSet_String}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(pkdataset, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-QBSelect}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(query){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[QBSelect]} query -- the query to load before showing the form. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-QBSelect_JSWindow}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(query, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-QBSelect_String}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(query, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-UUID}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(UUIDpk){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[UUID]} UUIDpk -- the UUIDpk to load before showing the form. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-UUID_JSWindow}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(UUIDpk, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-UUID_String}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(UUIDpk, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-Number}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(singleNumber_pk){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[Number]} singleNumber_pk -- the singleNumber\_pk to load before showing the form. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-Number_JSWindow}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(singleNumber_pk, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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 {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-Number_String}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(singleNumber_pk, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-String}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(query){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} query -- the query to load before showing the form. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-String_JSWindow}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(query, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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 {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-String_ObjectArray}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(query, argumentsArray){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} query -- the query to load before showing the form. \{[Object]\[]} argumentsArray -- the array of arguments for the query {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-String_ObjectArray_JSWindow}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(query, argumentsArray, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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 {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-String_ObjectArray_String}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(query, argumentsArray, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=showRecords-String_String}{tr:id=name}{td}h6.showRecords{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}showRecords{span}{span}\(query, window){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} 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"); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=sort-String}{tr:id=name}{td}h6.sort{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}sort{span}{span}\(sortString){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} sortString -- the specified columns (and sort order) {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.sort('columnA desc,columnB asc'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=sort-String_Boolean}{tr:id=name}{td}h6.sort{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}sort{span}{span}\(sortString, defer){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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). {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.sort('columnA desc,columnB asc'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=sortDialog}{tr:id=name}{td}h6.sortDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}sortDialog{span}{span}\(){span}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.sortDialog('columnA desc,columnB asc'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=sortDialog-String}{tr:id=name}{td}h6.sortDialog{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}sortDialog{span}{span}\(sortString){span}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} sortString -- the specified columns (and sort order) {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} forms.customer.controller.sortDialog('columnA desc,columnB asc'); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table} |