Page History

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.

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

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
deleteRecord() Delete currently selected record(s).

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
deleteRecord(record) Delete record from foundset.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
deleteRecord(index) Delete record with the given index.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
find() Set the foundset in find mode.

Table Row (tr)

Table Cell (td)
JSRecord

Table Cell (td)
getRecord(index) Get the record object at the index.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getRecordIndex(record) Get the record index.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getSelectedIndex() Get the current record index of the foundset.

Table Row (tr)

Table Cell (td)
JSRecord

Table Cell (td)
getSelectedRecord() Get the selected record.

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Boolean

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
Number

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

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setSelectedIndex(index) Set the current record index.

Table Row (tr)

Table Cell (td)
void

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

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	deleteAllRecords

Table Row (tr)

id	name

Table Cell (td)
deleteAllRecords

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

deleteAllRecords

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Delete all records in foundset, resulting in empty foundset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - boolean true if all records could be deleted.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var success = forms.customer.foundset.deleteAllRecords();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	deleteRecord

Table Row (tr)

id	name

Table Cell (td)
deleteRecord

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

deleteRecord

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - boolean true if all records could be deleted.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var success = forms.customer.foundset.deleteRecord();
//can return false incase of related foundset having records and orphans records are not allowed by the relation

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	deleteRecord-JSRecord

Table Row (tr)

id	name

Table Cell (td)
deleteRecord

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

deleteRecord

Span
(record)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Delete record from foundset.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - boolean true if record could be deleted.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	deleteRecord-Number

Table Row (tr)

id	name

Table Cell (td)
deleteRecord

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

deleteRecord

Span
(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Delete record with the given index.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - boolean true if record could be deleted.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	find

Table Row (tr)

id	name

Table Cell (td)
find

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

find

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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]"

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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()
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRecord-Number

Table Row (tr)

id	name

Table Cell (td)
getRecord

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSRecord

Span

style	font-weight: bold;

getRecord

Span
(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the record object at the index.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Number} index - record index

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSRecord - Record record.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var record = forms.customer.foundset.getRecord(index);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getRecordIndex-JSRecord

Table Row (tr)

id	name

Table Cell (td)
getRecordIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getRecordIndex

Span
(record)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSRecord} record - Record

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - int index.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var index = forms.customer.foundset.getRecordIndex(record);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getSelectedIndex

Table Row (tr)

id	name

Table Cell (td)
getSelectedIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getSelectedIndex

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the current record index of the foundset.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - int current index (1-based)

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getSelectedRecord

Table Row (tr)

id	name

Table Cell (td)
getSelectedRecord

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSRecord

Span

style	font-weight: bold;

getSelectedRecord

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the selected record.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSRecord - Record record.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var selectedRecord = forms.customer.foundset.getSelectedRecord();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getSize

Table Row (tr)

id	name

Table Cell (td)
getSize

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getSize

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - int current size.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isInFind

Table Row (tr)

id	name

Table Cell (td)
isInFind

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isInFind

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Check if this foundset is in find mode.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - boolean is in find mode.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//Returns true when find was called on this foundset and search has not been called yet
forms.customer.foundset.isInFind();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	loadAllRecords

Table Row (tr)

id	name

Table Cell (td)
loadAllRecords

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

loadAllRecords

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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,

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - true if records are loaded, false otherwise.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

forms.customer.foundset.loadAllRecords();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newRecord

Table Row (tr)

id	name

Table Cell (td)
newRecord

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

newRecord

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - int index of new record.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// 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
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	newRecord-Number_Boolean

Table Row (tr)

id	name

Table Cell (td)
newRecord

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

newRecord

Span
(index, changeSelection)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - int index of new record.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// 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
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	search

Table Row (tr)

id	name

Table Cell (td)
search

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

search

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number - the recordCount

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var recordCount = forms.customer.foundset.search();
//var recordCount = forms.customer.foundset.search(false,false); //to extend foundset

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setSelectedIndex-Number

Table Row (tr)

id	name

Table Cell (td)
setSelectedIndex

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setSelectedIndex

Span
(index)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the current record index.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//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);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	sort-Function

Table Row (tr)

id	name

Table Cell (td)
sort

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

sort

Span
(recordComparisonFunction)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} recordComparisonFunction - record comparator function

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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;
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 11

New Version Current

Key

deleteAllRecords

deleteRecord

deleteRecord

deleteRecord

find

getRecord

getRecordIndex

getSelectedIndex

getSelectedRecord

getSize

isInFind

loadAllRecords

newRecord

newRecord

search

setSelectedIndex

sort