Child pages
  • JSFoundSet
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

Unknown macro: {div}

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.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Unknown macro: {div}

A JSFoundset is a scriptable object, it contains record objects defined by its SQL. It does lazy load the PKs and records.
Each foundset has its own record set and selected index


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Property Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String[]

Unknown macro: {td}

alldataproviders
Get all dataproviders of the foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

multiSelect
Get or set the multiSelect flag of the foundset.


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

addFoundSetFilterParam(dataprovider, operator, value)
Add a filter parameter that is permanent per user session to limit a specified foundset of records.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

addFoundSetFilterParam(dataprovider, operator, value, name)
Add a filter parameter that is permanent per user session to limit a specified foundset of records.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

clear()
Clear the foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

deleteAllRecords()
Delete all records in foundset, resulting in empty foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

deleteRecord()
Delete currently selected record(s).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

deleteRecord(record)
Delete record from foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

deleteRecord(index)
Delete record with the given index.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFoundSet

Unknown macro: {td}

duplicateFoundSet()
Get a duplicate of the foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

duplicateRecord()
Duplicate current record, change selection to new record, place on top.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

duplicateRecord(onTop)
Duplicate selected record, change selection to new record.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

duplicateRecord(onTop, changeSelection)
Duplicate selected record.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

duplicateRecord(index)
Duplicate record at index in the foundset, change selection to new record, place on top.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

duplicateRecord(index, onTop)
Duplicate record at index in the foundset, change selection to new record.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

duplicateRecord(index, onTop, changeSelection)
Duplicate record at index in the foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

duplicateRecord(index, location)
Duplicate record at index in the foundset, change selection to new record.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

duplicateRecord(index, location, changeSelection)
Duplicate record at index in the foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

find()
Set the foundset in find mode.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getCurrentSort()
Get the current sort columns.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object

Unknown macro: {td}

getDataProviderValue(dataProviderID)
Get a value based on a dataprovider name.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getDataSource()
Get the datasource used.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object[][]

Unknown macro: {td}

getFoundSetFilterParams()
Get the list of previously defined foundset filters.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Object[][]

Unknown macro: {td}

getFoundSetFilterParams(filterName)
Get a previously defined foundset filter, using its given name.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

QBSelect

Unknown macro: {td}

getQuery()
Get the query that the foundset is currently using.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSRecord

Unknown macro: {td}

getRecord(index)
Get the record object at the index.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

getRecordIndex(record)
Get the record index.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getRelationName()
Gets the relation name (null if not a related foundset).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

getSelectedIndex()
Get the current record index of the foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number[]

Unknown macro: {td}

getSelectedIndexes()
Get the indexes of the selected records.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSRecord

Unknown macro: {td}

getSelectedRecord()
Get the selected record.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSRecord[]

Unknown macro: {td}

getSelectedRecords()
Get the selected records.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

getSize()
Get the number of records in this foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

hasConditions()
Check wether the foundset has any conditions from a previous find action.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

invertRecords()
Invert the foundset against all rows of the current table.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

isInFind()
Check if this foundset is in find mode.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

loadAllRecords()
Loads all accessible records from the datasource into the foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

loadOmittedRecords()
Loads the records that are currently omitted as a foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

loadRecords()
Reloads all last (related) records again, if, for example, after search in tabpanel.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

loadRecords(foundset)
Copies foundset data from another foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

loadRecords(dataset)
Loads a primary key dataset, will remove related sort.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

loadRecords(querybuilder)
Loads records into form foundset based on a query builder object (also known as 'Form by query').

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

loadRecords(uuidpk)
Loads a single record by primary key, will remove related sort.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

loadRecords(numberpk)
Loads a single record by primary key, will remove related sort.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

loadRecords(queryString)
Loads records into form foundset based on a query (also known as 'Form by query').

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

loadRecords(queryString, argumentsArray)
Loads records into form foundset based on a query (also known as 'Form by query').

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

newRecord()
Create a new record on top of the foundset and change selection to it.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

newRecord(onTop)
Create a new record in the foundset and change selection to it.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

newRecord(onTop, changeSelection)
Create a new record in the foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

newRecord(index)
Create a new record in the foundset and change selection to it.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

newRecord(index, changeSelection)
Create a new record in the foundset.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

omitRecord()
Omit current record, to be shown with loadOmittedRecords.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

omitRecord(index)
Omit record under the given index, to be shown with loadOmittedRecords.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

relookup()
Perform a relookup for the currently selected records
Lookups are defined in the dataprovider (columns) auto-enter setting and are normally performed over a relation upon record creation.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

relookup(index)
Perform a relookup for the record under the given index
Lookups are defined in the dataprovider (columns) auto-enter setting and are normally performed over a relation upon record creation.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

removeFoundSetFilterParam(name)
Remove a named foundset filter.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

selectRecord(pkid1, [pkid2], [pkidn])
Select the record based on pk data.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setDataProviderValue(dataProviderID, value)
Set a value based on a dataprovider name.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setSelectedIndex(index)
Set the current record index.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setSelectedIndexes(indexes)
Set the selected records indexes.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

sort(sortString)
Sorts the foundset based on the given sort string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

sort(sortString, defer)
Sorts the foundset based on the given sort string.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

sort(recordComparisonFunction)
Sorts the foundset based on the given record comparator function.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSFoundSet

Unknown macro: {td}

unrelate()
Create a new unrelated foundset that is a copy of the current foundset.


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Property Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
alldataproviders
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get all dataproviders of the foundset.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var dataprovidersNames = forms.customer.alldataproviders;
application.output("This foundset has " + dataprovidersNames.length + " data providers.")
for (var i=0; i<dataprovidersNames.length; i++)
	application.output(dataprovidersNames[i]);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
multiSelect
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get or set the multiSelect flag of the foundset.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// allow user to select multiple rows.
forms.customer.foundset.multiSelect = true;
Unknown macro: {tr}
Unknown macro: {td}


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
addFoundSetFilterParam
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

addFoundSetFilterParam

Unknown macro: {span}

(dataprovider, operator, value)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Add a filter parameter that is permanent per user session to limit a specified foundset of records.
Use clear() or loadAllRecords() to make the filter effective.
Multiple filters can be added to the same dataprovider, they will all be applied.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} dataprovider – String column to filter on.
{String} operator – String operator: =, <, >, >=, <=, !=, (NOT) LIKE, (NOT) IN, (NOT) BETWEEN and IS (NOT) NULL optionally augmented with modifiers "#" (ignore case) or "^||" (or-is-null).
{Object} value – Object filter value (for in array and between an array with 2 elements)

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if adding the filter succeeded, false otherwise.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// Filter a fondset on a dataprovider value.
// Note that multiple filters can be added to the same dataprovider, they will all be applied.

var success = forms.customer.foundset.addFoundSetFilterParam('customerid', '=', 'BLONP', 'custFilter');//possible to add multiple
forms.customer.foundset.loadAllRecords();//to make param(s) effective
// Named filters can be removed using forms.customer.foundset.removeFoundSetFilterParam(filterName)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
addFoundSetFilterParam
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

addFoundSetFilterParam

Unknown macro: {span}

(dataprovider, operator, value, name)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Add a filter parameter that is permanent per user session to limit a specified foundset of records.
Use clear() or loadAllRecords() to make the filter effective.
The filter is removed again using removeFoundSetFilterParam(name).

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} dataprovider – String column to filter on.
{String} operator – String operator: =, <, >, >=, <=, !=, (NOT) LIKE, (NOT) IN, (NOT) BETWEEN and IS (NOT) NULL optionally augmented with modifiers "#" (ignore case) or "^||" (or-is-null).
{Object} value – Object filter value (for in array and between an array with 2 elements)
{String} name – String name, used to remove the filter again.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if adding the filter succeeded, false otherwise.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var success = forms.customer.foundset.addFoundSetFilterParam('customerid', '=', 'BLONP', 'custFilter');//possible to add multiple
// Named filters can be removed using forms.customer.foundset.removeFoundSetFilterParam(filterName)

// you can use modifiers in the operator as well, filter on companies where companyname is null or equals-ignore-case 'servoy'
var ok = forms.customer.foundset.addFoundSetFilterParam('companyname', '#^||=', 'servoy')

forms.customer.foundset.loadAllRecords();//to make param(s) effective
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
clear
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

clear

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Clear the foundset.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//Clear the foundset, including searches that may be on it
forms.customer.foundset.clear();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
deleteAllRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

deleteAllRecords

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Delete all records in foundset, resulting in empty foundset.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – boolean true if all records could be deleted.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var success = forms.customer.foundset.deleteAllRecords();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
deleteRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

deleteRecord

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Delete currently selected record(s).
If the foundset is in multiselect mode, all selected records are deleted.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – boolean true if all records could be deleted.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var success = forms.customer.foundset.deleteRecord();
//can return false incase of related foundset having records and orphans records are not allowed by the relation
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
deleteRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

deleteRecord

Unknown macro: {span}

(record)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Delete record from foundset.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSRecord} record – The record to delete from the foundset.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – boolean true if record could be deleted.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var success = forms.customer.foundset.deleteRecord(rec);
//can return false incase of related foundset having records and orphans records are not allowed by the relation
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
deleteRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

deleteRecord

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Delete record with the given index.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – The index of the record to delete.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – boolean true if record could be deleted.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var success = forms.customer.foundset.deleteRecord(4);
//can return false incase of related foundset having records and orphans records are not allowed by the relation
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
duplicateFoundSet
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFoundSet

Unknown macro: {span}

duplicateFoundSet

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get a duplicate of the foundset.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFoundSet – foundset duplicate.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var dupFoundset = forms.customer.foundset.duplicateFoundSet();
forms.customer.foundset.find();
//search some fields
var count = forms.customer.foundset.search();
if (count == 0)
{
	plugins.dialogs.showWarningDialog('Alert', 'No records found','OK');
	forms.customer.foundset.loadRecords(dupFoundset);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
duplicateRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

duplicateRecord

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Duplicate current record, change selection to new record, place on top.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – 0 if record was not created or the record index if it was created.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.duplicateRecord();
forms.customer.foundset.duplicateRecord(false); //duplicate the current record, adds at bottom
forms.customer.foundset.duplicateRecord(1,2); //duplicate the first record as second record
//duplicates the record (record index 3), adds on top and selects the record
forms.customer.foundset.duplicateRecord(3,true,true);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
duplicateRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

duplicateRecord

Unknown macro: {span}

(onTop)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Duplicate selected record, change selection to new record.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Boolean} onTop – when true the new record is added as the topmost record.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – 0 if record was not created or the record index if it was created.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.duplicateRecord();
forms.customer.foundset.duplicateRecord(false); //duplicate the current record, adds at bottom
forms.customer.foundset.duplicateRecord(1,2); //duplicate the first record as second record
//duplicates the record (record index 3), adds on top and selects the record
forms.customer.foundset.duplicateRecord(3,true,true);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
duplicateRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

duplicateRecord

Unknown macro: {span}

(onTop, changeSelection)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Duplicate selected record.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Boolean} onTop – when true the new record is added as the topmost record.
{Boolean} changeSelection – when true the selection is changed to the duplicated record.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – 0 if record was not created or the record index if it was created.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.duplicateRecord();
forms.customer.foundset.duplicateRecord(false); //duplicate the current record, adds at bottom
forms.customer.foundset.duplicateRecord(1,2); //duplicate the first record as second record
//duplicates the record (record index 3), adds on top and selects the record
forms.customer.foundset.duplicateRecord(3,true,true);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
duplicateRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

duplicateRecord

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Duplicate record at index in the foundset, change selection to new record, place on top.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – The index of the record to duplicate; defaults to currently selected index. Ignored if first given parameter is a boolean value.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – 0 if record was not created or the record index if it was created.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.duplicateRecord();
forms.customer.foundset.duplicateRecord(false); //duplicate the current record, adds at bottom
forms.customer.foundset.duplicateRecord(1,2); //duplicate the first record as second record
//duplicates the record (record index 3), adds on top and selects the record
forms.customer.foundset.duplicateRecord(3,true,true);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
duplicateRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

duplicateRecord

Unknown macro: {span}

(index, onTop)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Duplicate record at index in the foundset, change selection to new record.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – The index of the record to duplicate; defaults to currently selected index. Ignored if first given parameter is a boolean value.
{Boolean} onTop – when true the new record is added as the topmost record.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – 0 if record was not created or the record index if it was created.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.duplicateRecord();
forms.customer.foundset.duplicateRecord(false); //duplicate the current record, adds at bottom
forms.customer.foundset.duplicateRecord(1,2); //duplicate the first record as second record
//duplicates the record (record index 3), adds on top and selects the record
forms.customer.foundset.duplicateRecord(3,true,true);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
duplicateRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

duplicateRecord

Unknown macro: {span}

(index, onTop, changeSelection)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Duplicate record at index in the foundset.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – The index of the record to duplicate; defaults to currently selected index. Ignored if first given parameter is a boolean value.
{Boolean} onTop – when true the new record is added as the topmost record.
{Boolean} changeSelection – when true the selection is changed to the duplicated record.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – 0 if record was not created or the record index if it was created.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.duplicateRecord();
forms.customer.foundset.duplicateRecord(false); //duplicate the current record, adds at bottom
forms.customer.foundset.duplicateRecord(1,2); //duplicate the first record as second record
//duplicates the record (record index 3), adds on top and selects the record
forms.customer.foundset.duplicateRecord(3,true,true);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
duplicateRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

duplicateRecord

Unknown macro: {span}

(index, location)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Duplicate record at index in the foundset, change selection to new record.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – The index of the record to duplicate; defaults to currently selected index. Ignored if first given parameter is a boolean value.
{Number} location – the new record is added at specified index

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – 0 if record was not created or the record index if it was created.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.duplicateRecord();
forms.customer.foundset.duplicateRecord(false); //duplicate the current record, adds at bottom
forms.customer.foundset.duplicateRecord(1,2); //duplicate the first record as second record
//duplicates the record (record index 3), adds on top and selects the record
forms.customer.foundset.duplicateRecord(3,true,true);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
duplicateRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

duplicateRecord

Unknown macro: {span}

(index, location, changeSelection)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Duplicate record at index in the foundset.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – The index of the record to duplicate; defaults to currently selected index. Ignored if first given parameter is a boolean value.
{Number} location – the new record is added at specified index
{Boolean} changeSelection – when true the selection is changed to the duplicated record.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – 0 if record was not created or the record index if it was created.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.duplicateRecord();
forms.customer.foundset.duplicateRecord(false); //duplicate the current record, adds at bottom
forms.customer.foundset.duplicateRecord(1,2); //duplicate the first record as second record
//duplicates the record (record index 3), adds on top and selects the record
forms.customer.foundset.duplicateRecord(3,true,true);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
find
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

find

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Set the foundset in find mode. (Start a find request), use the "search" function to perform/exit the find.

Before going into find mode, all unsaved records will be saved in the database.
If this fails (due to validation failures or sql errors) or is not allowed (autosave off), the foundset will not go into find mode.
Make sure the operator and the data (value) are part of the string passed to dataprovider (included inside a pair of quotation marks).
Note: always make sure to check the result of the find() method.

When in find mode, columns can be assigned string expressions (including operators) that are evaluated as:
General:
c1||c2 (condition1 or condition2)
c|format (apply format on condition like 'x|dd-MM-yyyy')
!c (not condition)
#c (modify condition, depends on column type)
^ (is null)
^= (is null or empty)
<x (less than value x)
>x (greater than value x)
<=x (less than or equals value x)
>=x (greater than or equals value x)
x...y (between values x and y, including values)
x (equals value x)

Number fields:
=x (equals value x)
^= (is null or zero)

Date fields:
#c (equals value x, entire day)
now (equals now, date and or time)
// (equals today)
today (equals today)

Text fields:
#c (case insensitive condition)
= x (equals a space and 'x')
^= (is null or empty)
%x% (contains 'x')
%x_y% (contains 'x' followed by any char and 'y')
% (contains char '%')
\_ (contains char '_')

Related columns can be assigned, they will result in related searches.
For example, "employees_to_department.location_id = headoffice" finds all employees in the specified location).

Searching on related aggregates is supported.
For example, "orders_to_details.total_amount = '>1000'" finds all orders with total order details amount more than 1000.

Arrays can be used for searching a number of values, this will result in an 'IN' condition that will be used in the search.
The values are not restricted to strings but can be any type that matches the column type.
For example, "record.department_id = [1, 33, 99]"

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if the foundset is now in find mode, false otherwise.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
if (forms.customer.foundset.find()) //find will fail if autosave is disabled and there are unsaved records
{
	columnTextDataProvider = 'a search value'
	// for numbers you have to make sure to format it correctly so that the decimal point is in your locales notation (. or ,)
	columnNumberDataProvider = '>' + utils.numberFormat(anumber, '####.00');
	columnDateDataProvider = '31-12-2010|dd-MM-yyyy'
	forms.customer.foundset.search()
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getCurrentSort
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getCurrentSort

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the current sort columns.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – String sort columns

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//reverse the current sort

//the original sort "companyName asc, companyContact desc"
//the inversed sort "companyName desc, companyContact asc"
var foundsetSort = foundset.getCurrentSort()
var sortColumns = foundsetSort.split(',')
var newFoundsetSort = ''
for(var i=0; i<sortColumns.length; i++)
{
	var currentSort = sortColumns[i]
	var sortType = currentSort.substring(currentSort.length-3)
	if(sortType.equalsIgnoreCase('asc'))
	{
		newFoundsetSort += currentSort.replace(' asc', ' desc')
	}
	else
	{
		newFoundsetSort += currentSort.replace(' desc', ' asc')
	}
	if(i != sortColumns.length - 1)
	{
		newFoundsetSort += ','
	}
}
foundset.sort(newFoundsetSort)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getDataProviderValue
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object

Unknown macro: {span}

getDataProviderValue

Unknown macro: {span}

(dataProviderID)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get a value based on a dataprovider name.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} dataProviderID – data provider name

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object – Object value

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var val = forms.customer.foundset.getDataProviderValue('contact_name');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getDataSource
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getDataSource

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the datasource used.
The datasource is an url that describes the data source.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – String data source.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var dataSource = forms.customer.foundset.getDataSource();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFoundSetFilterParams
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object[][]

Unknown macro: {span}

getFoundSetFilterParams

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the list of previously defined foundset filters.
The result is an array of:
[ tableName, dataprovider, operator, value, name ]

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object[][] – Array of filter definitions.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var params = foundset.getFoundSetFilterParams()
for (var i = 0; params != null && i < params.length; i++)
{
	application.output('FoundSet filter on table ' + params[i][0]+ ': '+ params[i][1]+ ' '+params[i][2]+ ' '+params[i][3] +(params[i][4] == null ? ' [no name]' : ' ['+params[i][4]+']'))
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getFoundSetFilterParams
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Object[][]

Unknown macro: {span}

getFoundSetFilterParams

Unknown macro: {span}

(filterName)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get a previously defined foundset filter, using its given name.
The result is an array of:
[ tableName, dataprovider, operator, value, name ]

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} filterName – name of the filter to retrieve.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Object[][] – Array of filter definitions.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var params = foundset.getFoundSetFilterParams()
for (var i = 0; params != null && i < params.length; i++)
{
	application.output('FoundSet filter on table ' + params[i][0]+ ': '+ params[i][1]+ ' '+params[i][2]+ ' '+params[i][3] +(params[i][4] == null ? ' [no name]' : ' ['+params[i][4]+']'))
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getQuery
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

QBSelect

Unknown macro: {span}

getQuery

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the query that the foundset is currently using.
When the founset is in find mode, the find conditions are included in the resulting query.
So the query that would be used when just calling search() (or search(true,true)) is returned.
Note that foundset filters are included and table filters are not included in the query.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

QBSelect – query.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var q = foundset.getQuery()
q.where.add(q.columns.x.eq(100))
foundset.loadRecords(q);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSRecord

Unknown macro: {span}

getRecord

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the record object at the index.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – record index

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSRecord – Record record.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var record = forms.customer.foundset.getRecord(index);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRecordIndex
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getRecordIndex

Unknown macro: {span}

(record)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the record index. Will return -1 if the record can't be found.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSRecord} record – Record

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – int index.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var index = forms.customer.foundset.getRecordIndex(record);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getRelationName
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getRelationName

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Gets the relation name (null if not a related foundset).

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – String relation name when related.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var relName = forms.customer.foundset.getRelationName();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getSelectedIndex
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getSelectedIndex

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the current record index of the foundset.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – int current index (1-based)

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//gets the current record index in the current foundset
var current = forms.customer.foundset.getSelectedIndex();
//sets the next record in the foundset
forms.customer.foundset.setSelectedIndex(current+1);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getSelectedIndexes
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number[]

Unknown macro: {span}

getSelectedIndexes

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the indexes of the selected records.
When the founset is in multiSelect mode (see property multiSelect), a selection can consist of more than one index.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number[] – Array current indexes (1-based)

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// modify selection to the first selected item and the following row only
var current = forms.customer.foundset.getSelectedIndexes();
if (current.length > 1)
{
	var newSelection = new Array();
	newSelection[0] = current[0]; // first current selection
	newSelection[1] = current[0] + 1; // and the next row
	forms.customer.foundset.setSelectedIndexes(newSelection);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getSelectedRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSRecord

Unknown macro: {span}

getSelectedRecord

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the selected record.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSRecord – Record record.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var selectedRecord = forms.customer.foundset.getSelectedRecord();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getSelectedRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSRecord[]

Unknown macro: {span}

getSelectedRecords

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the selected records.
When the founset is in multiSelect mode (see property multiSelect), selection can be a more than 1 record.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSRecord[] – Array current records.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var selectedRecords = forms.customer.foundset.getSelectedRecords();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getSize
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getSize

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Get the number of records in this foundset.
This is the number of records loaded, note that when looping over a foundset, size() may
increase as more records are loaded.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – int current size.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var nrRecords = forms.customer.foundset.getSize()

// to loop over foundset, recalculate size for each record
for (var i = 1; i <= forms.customer.foundset.getSize(); i++)
{
	var rec = forms.customer.foundset.getRecord(i);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
hasConditions
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

hasConditions

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Check wether the foundset has any conditions from a previous find action.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – wether the foundset has find-conditions

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
if (forms.customer.foundset.hasConditions())
{
		// foundset had find actions
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
invertRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

invertRecords

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Invert the foundset against all rows of the current table.
All records that are not in the foundset will become the current foundset.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.invertRecords();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
isInFind
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

isInFind

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Check if this foundset is in find mode.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – boolean is in find mode.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//Returns true when find was called on this foundset and search has not been called yet
forms.customer.foundset.isInFind();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadAllRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

loadAllRecords

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Loads all accessible records from the datasource into the foundset.
Filters on the foundset are applied.

Before loading the records, all unsaved records will be saved in the database.
If this fails (due to validation failures or sql errors) or is not allowed (autosave off),
records will not be loaded,

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if records are loaded, false otherwise.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.loadAllRecords();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadOmittedRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

loadOmittedRecords

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Loads the records that are currently omitted as a foundset.

Before loading the omitted records, all unsaved records will be saved in the database.
If this fails (due to validation failures or sql errors) or is not allowed (autosave off),
omitted records will not be loaded,

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if records are loaded, false otherwise.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.loadOmittedRecords();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

loadRecords

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Reloads all last (related) records again, if, for example, after search in tabpanel.
When in find mode, this will reload the records from before the find() call.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if successful

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//to reload all last (related) records again, if for example when searched in tabpanel
 forms.customer.foundset.loadRecords();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

loadRecords

Unknown macro: {span}

(foundset)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Copies foundset data from another foundset.
This will alter the foundset state to the state of the foundset that is given.
If you really just want to use the given foundset on the form itself, then you need to use controller.loadRecords(foundset)
that will change the instance of the foundset that is used for this form. Not just update an existing form.

If you copy over a relation into this foundset, then this foundset will not be a related foundset, it will not automatically update its state
of records are updated or added that belong to that relation. It will only be a snapshot of that related foundsets state.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSFoundSet} foundset – The foundset to load records from

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if successful

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//Copies foundset data from another foundset
forms.customer.foundset.loadRecords(fs);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

loadRecords

Unknown macro: {span}

(dataset)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Loads a primary key dataset, will remove related sort.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{JSDataSet} dataset – pkdataset

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if successful

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// loads a primary key dataset, will remove related sort!
//var dataset = databaseManager.getDataSetByQuery(...);
// dataset must match the table primary key columns (alphabetically ordered)
forms.customer.foundset.loadRecords(dataset);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

loadRecords

Unknown macro: {span}

(querybuilder)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Loads records into form foundset based on a query builder object (also known as 'Form by query').
When the founset is in find mode, the find states are discarded, the foundset will go out of find mode and the foundset will be loaded using the query.
If the foundset is related, the relation-condition will be added to the query.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{QBSelect} querybuilder – the query builder

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if successful

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.loadRecords(qbselect);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

loadRecords

Unknown macro: {span}

(uuidpk)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{UUID} uuidpk – single-column pk value

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if successful

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//Loads a single record by primary key, will remove related sort!
forms.customer.foundset.loadRecords(application.getUUID('6b5e2f5d-047e-45b3-80ee-3a32267b1f20'));
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

loadRecords

Unknown macro: {span}

(numberpk)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} numberpk – single-column pk value

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if successful

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//Loads a single record by primary key, will remove related sort!
forms.customer.foundset.loadRecords(123);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

loadRecords

Unknown macro: {span}

(queryString)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

see foundset.loadRecords(QBSelect).

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} queryString – select statement

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if successful

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//loads records in to the foundset based on a query (also known as 'Form by query')
forms.customer.foundset.loadRecords(sqlstring);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadRecords
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

loadRecords

Unknown macro: {span}

(queryString, argumentsArray)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

see foundset.loadRecords(QBSelect).

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} queryString – select statement
{Object[]} argumentsArray – arguments to query

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if successful

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//loads records in to the foundset based on a query (also known as 'Form by query')
forms.customer.foundset.loadRecords(sqlstring,parameters);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

newRecord

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Create a new record on top of the foundset and change selection to it. Returns -1 if the record can't be made.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – int index of new record.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// foreign key data is only filled in for equals (=) relation items 
var idx = forms.customer.foundset.newRecord(false); // add as last record
// forms.customer.foundset.newRecord(); // adds as first record
// forms.customer.foundset.newRecord(2); //adds as second record
if (idx >= 0) // returned index is -1 in case of failure 
{
	forms.customer.foundset.some_column = "some text";
	application.output("added on position " + idx);
	// when adding at the end of the foundset, the returned index
	// corresponds with the size of the foundset
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

newRecord

Unknown macro: {span}

(onTop)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Create a new record in the foundset and change selection to it. Returns -1 if the record can't be made.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Boolean} onTop – when true the new record is added as the topmost record.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – int index of new record.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// foreign key data is only filled in for equals (=) relation items 
var idx = forms.customer.foundset.newRecord(false); // add as last record
// forms.customer.foundset.newRecord(); // adds as first record
// forms.customer.foundset.newRecord(2); //adds as second record
if (idx >= 0) // returned index is -1 in case of failure 
{
	forms.customer.foundset.some_column = "some text";
	application.output("added on position " + idx);
	// when adding at the end of the foundset, the returned index
	// corresponds with the size of the foundset
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

newRecord

Unknown macro: {span}

(onTop, changeSelection)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Create a new record in the foundset. Returns -1 if the record can't be made.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Boolean} onTop – when true the new record is added as the topmost record.
{Boolean} changeSelection – when true the selection is changed to the new record.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – int index of new record.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// foreign key data is only filled in for equals (=) relation items 
var idx = forms.customer.foundset.newRecord(false); // add as last record
// forms.customer.foundset.newRecord(); // adds as first record
// forms.customer.foundset.newRecord(2); //adds as second record
if (idx >= 0) // returned index is -1 in case of failure 
{
	forms.customer.foundset.some_column = "some text";
	application.output("added on position " + idx);
	// when adding at the end of the foundset, the returned index
	// corresponds with the size of the foundset
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

newRecord

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Create a new record in the foundset and change selection to it. Returns -1 if the record can't be made.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – the new record is added at specified index.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – int index of new record.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// foreign key data is only filled in for equals (=) relation items 
var idx = forms.customer.foundset.newRecord(false); // add as last record
// forms.customer.foundset.newRecord(); // adds as first record
// forms.customer.foundset.newRecord(2); //adds as second record
if (idx >= 0) // returned index is -1 in case of failure 
{
	forms.customer.foundset.some_column = "some text";
	application.output("added on position " + idx);
	// when adding at the end of the foundset, the returned index
	// corresponds with the size of the foundset
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
newRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

newRecord

Unknown macro: {span}

(index, changeSelection)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Create a new record in the foundset. Returns -1 if the record can't be made.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – the new record is added at specified index.
{Boolean} changeSelection – when true the selection is changed to the new record.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – int index of new record.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// foreign key data is only filled in for equals (=) relation items 
var idx = forms.customer.foundset.newRecord(false); // add as last record
// forms.customer.foundset.newRecord(); // adds as first record
// forms.customer.foundset.newRecord(2); //adds as second record
if (idx >= 0) // returned index is -1 in case of failure 
{
	forms.customer.foundset.some_column = "some text";
	application.output("added on position " + idx);
	// when adding at the end of the foundset, the returned index
	// corresponds with the size of the foundset
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
omitRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

omitRecord

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Omit current record, to be shown with loadOmittedRecords.
If the foundset is in multiselect mode, all selected records are omitted (when no index parameter is used).

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – boolean true if all records could be omitted.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var success = forms.customer.foundset.omitRecord();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
omitRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

omitRecord

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Omit record under the given index, to be shown with loadOmittedRecords.
If the foundset is in multiselect mode, all selected records are omitted (when no index parameter is used).

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – The index of the record to omit.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – boolean true if all records could be omitted.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var success = forms.customer.foundset.omitRecord();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
relookup
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

relookup

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Perform a relookup for the currently selected records
Lookups are defined in the dataprovider (columns) auto-enter setting and are normally performed over a relation upon record creation.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.relookup(1);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
relookup
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

relookup

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Perform a relookup for the record under the given index
Lookups are defined in the dataprovider (columns) auto-enter setting and are normally performed over a relation upon record creation.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – record index (1-based)

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.relookup(1);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
removeFoundSetFilterParam
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

removeFoundSetFilterParam

Unknown macro: {span}

(name)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Remove a named foundset filter.
Use clear() or loadAllRecords() to make the filter effective.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} name – String filter name.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if removing the filter succeeded, false otherwise.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var success = forms.customer.foundset.removeFoundSetFilterParam('custFilter');// removes all filters with this name
forms.customer.foundset.loadAllRecords();//to make param(s) effective
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
search
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

search

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – the recordCount

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var recordCount = forms.customer.foundset.search();
//var recordCount = forms.customer.foundset.search(false,false); //to extend foundset
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
search
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

search

Unknown macro: {span}

(clearLastResults)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Boolean} clearLastResults – boolean, clear previous search, default true

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – the recordCount

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var recordCount = forms.customer.foundset.search();
//var recordCount = forms.customer.foundset.search(false,false); //to extend foundset
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
search
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

search

Unknown macro: {span}

(clearLastResults, reduceSearch)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Boolean} clearLastResults – boolean, clear previous search, default true
{Boolean} reduceSearch – boolean, reduce (true) or extend (false) previous search results, default true

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – the recordCount

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var recordCount = forms.customer.foundset.search();
//var recordCount = forms.customer.foundset.search(false,false); //to extend foundset
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
selectRecord
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

selectRecord

Unknown macro: {span}

(pkid1, [pkid2], [pkidn])

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Select the record based on pk data.
Note that if the foundset has not loaded the record with the pk, selectrecord will fail.

In case of a table with a composite key, the pk sequence must match the alphabetical
ordering of the pk column names.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

pkid1 – primary key
[pkid2] – second primary key (in case of composite primary key)
[pkidn] – nth primary key

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean – true if succeeded.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.selectRecord(pkid1,pkid2,pkidn);//pks must be alphabetically set! It is also possible to use an array as parameter.
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setDataProviderValue
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setDataProviderValue

Unknown macro: {span}

(dataProviderID, value)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Set a value based on a dataprovider name.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} dataProviderID – data provider name
{Object} value – value to set

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.setDataProviderValue('contact_name','mycompany');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setSelectedIndex
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setSelectedIndex

Unknown macro: {span}

(index)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Set the current record index.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number} index – index to set (1-based)

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//gets the current record index in the current foundset
var current = forms.customer.foundset.getSelectedIndex();
//sets the next record in the foundset
forms.customer.foundset.setSelectedIndex(current+1);
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setSelectedIndexes
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setSelectedIndexes

Unknown macro: {span}

(indexes)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Set the selected records indexes.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Number[]} indexes – An array with indexes to set.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// modify selection to the first selected item and the following row only
var current = forms.customer.foundset.getSelectedIndexes();
if (current.length > 1)
{
	var newSelection = new Array();
	newSelection[0] = current[0]; // first current selection
	newSelection[1] = current[0] + 1; // and the next row
	forms.customer.foundset.setSelectedIndexes(newSelection);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
sort
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

sort

Unknown macro: {span}

(sortString)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Sorts the foundset based on the given sort string.
TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} sortString – the specified columns (and sort order)

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.sort('columnA desc,columnB asc');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
sort
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

sort

Unknown macro: {span}

(sortString, defer)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Sorts the foundset based on the given sort string.
TIP: You can use the Copy button in the developer Select Sorting Fields dialog to get the needed syntax string for the desired sort fields/order.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} sortString – the specified columns (and sort order)
{Boolean} defer – when true, 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).

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.sort('columnA desc,columnB asc');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
sort
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

sort

Unknown macro: {span}

(recordComparisonFunction)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Sorts the foundset based on the given record comparator function.
The comparator function is called to compare
two records, that are passed as arguments, and
it will return -1/0/1 if the first record is less/equal/greater
then the second record.

The function based sorting does not work with printing.
It is just a temporary in-memory sort.

NOTE: starting with 7.2 release this function doesn't save the data anymore

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{Function} recordComparisonFunction – record comparator function

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.sort(mySortFunction);

function mySortFunction(r1, r2)
{
	var o = 0;
	if(r1.id < r2.id)
	{
		o = -1;
	}
	else if(r1.id > r2.id)
	{
		o = 1;
	}
	return o;
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
unrelate
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSFoundSet

Unknown macro: {span}

unrelate

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Create a new unrelated foundset that is a copy of the current foundset.
If the current foundset is not related, no copy will made.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSFoundSet – FoundSet unrelated foundset.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
forms.customer.foundset.unrelate();
Unknown macro: {tr}
Unknown macro: {td}
  • No labels