Page History

Divcache

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

Constants Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)CUSTOM_VALUES

indexstyle	true	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.

refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

idclass

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

Table Cell (td)
Number

Table Cell (td)DATABASE_VALUES

servoy sSummary

12%

30%

58%

height: 30px;

3

Constants Summary

Constant to set the valueListType of a JSValueList.

Table Row (tr)

Constant to set the valueListType of a JSValueList.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)EMPTY_VALUE_ALWAYS
Constant to set/get the addEmptyValue Table Row (tr)

Table Cell (td)
Number

Table Cell (td)EMPTY_VALUE_NEVER

Constant to set/get the addEmptyValue property of a JSValueList.

HTML Table

Colgroup Tag

Col

width	80px

Col

Table Head (thead) Table Row (tr)style

servoy sSummary

idclass

12%

30%

58%

height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)addEmptyValue

3

Property Summary

Property that tells if an empty value must be shown next to the items in the value list.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)customValues
A string

A string with the elements in the valuelist.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)dataSource

Compact representation of the names of the server and table that

Table Row (tr)

Table Cell (td)
JSValueList

Table Cell (td)fallbackValueList

are used for loading the data from the database.

Table Row (tr)

Table Cell (td)
JSMethod

Table Cell (td)
globalMethod A global method that provides the data for the valuelist.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)name

Gets or sets the fallback valuelist.

The global method of the valuelist is called to fill in or adjust the values of the valuelist.

A property special for NGClient and GlobalValuelist to only query the global valuelist when it is needed.

The name of the value list.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)relationName

The name of the relation that is used for loading data from the database.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)separator

A String representing the separator that should be used when multiple

display dataproviders are set, when the value list has the type set to

Table Row (tr)

Table Cell (td)
String

Table Cell (td)serverName

database values.

The name of the database server that is used for loading the values when

Table Row (tr) Table Cell (td)

the value list has the type set to database/table values.

void

Table Cell (td)
setFallbackValueList

Table Row (tr)

Table Cell (td)
String

Table Cell (td)sortOptions

Sort options that are applied when the valuelist loads its data

from the database.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)tableName

The name of the database table that is used for loading the values when

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)useTableFilter

the value list has the type set to database/table values.

Flag that tells if the name of the valuelist should be applied as a filter on the

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)valueListType

'valuelist_name' column when retrieving the data from the database.

The type of the valuelist.

HTML Table

Colgroup Tag

Col

width	80px

Col

Table Head (thead) Table Row (tr)style

servoy sSummary

12%

30%

58%

height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
Object[]

Table Cell (td)getDisplayDataProviderIds()

3

Methods Summary

Returns an array of the dataproviders that will be used to display the valuelist value.

Table Row (tr)

Table Cell (td)
Object[]

Table Cell (td)getReturnDataProviderIds()
Returns an

Returns an array of the dataproviders that will be used to define the valuelist value that is saved.

Table Row (tr)

Table Cell (td)
UUID

Table Cell (td)getUUID()
Table Row (tr) Table Cell (td)

Returns the UUID of the value list

void

Table Cell (td)setDisplayDataProviderIds()
Table Row (tr) Table Cell (td)

Set the display dataproviders.

void

Table Cell (td)setDisplayDataProviderIds(dataprovider1)
Table Row (tr) Table Cell (td)

Set the display dataproviders.

void

Table Cell (td)setDisplayDataProviderIds(dataprovider1, dataprovider2)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
setDisplayDataProviderIds(dataprovider1, dataprovider2, dataprovider3) Set the display dataproviders.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)setReturnDataProviderIds()

Set the display dataproviders.

Table Row (tr) Table Cell (td)

void

Set the display dataproviders.

void

Set the return dataproviders.

void

Table Cell (td)setReturnDataProviderIds(dataprovider1)
Table Row (tr) Table Cell (td)

Set the return dataproviders.

void

Table Cell (td)setReturnDataProviderIds(dataprovider1, dataprovider2)
Table Row (tr) Table Cell (td)

Set the return dataproviders.

void

Table Cell (td)setReturnDataProviderIds(dataprovider1, dataprovider2, dataprovider3)

Set the return dataproviders.

table

id

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead) Table Row (tr)style

constant

classservoy sDetail

servoy sDetail

2100%

height:30px

; Table Head (th)colspan

2

Constants Details

Table Body (tbody)idid

CUSTOM_VALUES

Table Row (tr)

name

Table Cell (td)

CUSTOM_VALUES

Table Row (tr)id

des

Table Cell (td) Divclass

sIndent

Constant to set the valueListType of a JSValueList.


Sets the value list to use a custom list of values.


Also used in solutionModel.newValueList(...) to create new valuelists

tr

ret

id

Returns

ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.valueListType = JSValueList.CUSTOM_VALUES; // Change the type to custom values.
vlist.customValues = "one\ntwo\nthree\nfour";

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	DATABASE_VALUES

Table Row (tr)

id	name

Table Cell (td)
DATABASE_VALUES

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant to set the valueListType of a JSValueList.
Sets the value list to use values loaded from a database.
Also used in solutionModel.newValueList(...) to create new valuelists

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	EMPTY_VALUE_ALWAYS

Table Row (tr)

id	name

Table Cell (td)
EMPTY_VALUE_ALWAYS

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant to set/get the addEmptyValue property of a JSValueList.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
vlist.addEmptyValue = JSValueList.EMPTY_VALUE_ALWAYS;
var cmb = form.newComboBox('my_table_text', 10, 10, 100, 20);
cmb.valuelist = vlist;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	EMPTY_VALUE_NEVER

Table Row (tr)

id	name

Table Cell (td)
EMPTY_VALUE_NEVER

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Constant to set/get the addEmptyValue property of a JSValueList.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
vlist.addEmptyValue = JSValueList.EMPTY_VALUE_NEVER;
var cmb = form.newComboBox('my_table_text', 10, 10, 100, 20);
cmb.valuelist = vlist;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	property
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

Property Details

Table Body (tbody)

id	addEmptyValue

Table Row (tr)

id	name

Table Cell (td)
addEmptyValue

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Property that tells if an empty value must be shown next to the items in the value list.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.customValues = "one\ntwo\nthree\nfour";
vlist.addEmptyValue = JSValueList.EMPTY_VALUE_NEVER;
var cmb = form.newComboBox('my_table_text', 10, 10, 100, 20);
cmb.valuelist = vlist;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	customValues

Table Row (tr)

id	name

Table Cell (td)
customValues

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

A string with the elements in the valuelist. The elements
can be separated by linefeeds (custom1
custom2), optional with realvalues ((custom1|1
custom2|2)).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vl1 = solutionModel.newValueList("customtext",JSValueList.CUSTOM_VALUES);
vl1.customValues = "customvalue1\ncustomvalue2";
var vl2 = solutionModel.newValueList("customid",JSValueList.CUSTOM_VALUES);
vl2.customValues = "customvalue1|1\ncustomvalue2|2";
var form = solutionModel.newForm("customvaluelistform",controller.getDataSource(),null,true,300,300);
var combo1 = form.newComboBox("scopes.globals.text",10,10,120,20);
combo1.valuelist = vl1;
var combo2 = form.newComboBox("scopes.globals.id",10,60,120,20);
combo2.valuelist = vl2;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	dataSource

Table Row (tr)

id	name

Table Cell (td)
dataSource

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Compact representation of the names of the server and table that
are used for loading the data from the database.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	fallbackValueList

Table Row (tr)

id	name

Table Cell (td)
fallbackValueList

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets or sets the fallback valuelist.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSValueList

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var myValueList = solutionModel.getValueList('myValueListHere')
 //get fallback value list
var fallbackValueList = myValueList.fallbackValueList

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	globalMethod

Table Row (tr)

id	name

Table Cell (td)
globalMethod

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

A global method that provides the data for the valuelist. The global method must provided the data
as a JSDataSet.

It is called when the valuelist needs data, it has 3 modes.
real and display params both null: return the whole list
only display is specified, called by a typeahead, return a filtered list
only real value is specified, called when the list doesnt contain the real value for the give record value, this will insert this value into the existing list.

In find mode the record with be the FindRecord which is just like a normal JSRecord (DataRecord) it has the same properties (column/dataproviders) but doesnt have its methods (like isEditing())

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSMethod

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var listProvider = solutionModel.newGlobalMethod('globals', 'function getDataSetForValueList(displayValue, realValue, record, valueListName, findMode) {' +
		'	' +
		'var args = null;' +
		'/** @type QBSelect<db:/example_data/employees> */' +
		'var query = databaseManager.createSelect('db:/example_data/employees');' +
		'/** @type  {JSDataSet} */' +
		'var result = null;' +
		'if (displayValue == null && realValue == null) {' +
		'  // TODO think about caching this result. can be called often!' +
		'  // return the complete list' +
		'  query.result.add(query.columns.firstname.concat(' ').concat(query.columns.lastname)).add(query.columns.employeeid);' +
		'  result = databaseManager.getDataSetByQuery(query,100);' +
		'} else if (displayValue != null) {' +
		'  // TYPE_AHEAD filter call, return a filtered list' +
		'  args = [displayValue + "%", displayValue + "%"]' +
		'  query.result.add(query.columns.firstname.concat(' ').concat(query.columns.lastname)).add(query.columns.employeeid).' +
		'  root.where.add(query.or.add(query.columns.firstname.lower.like(args[0] + '%')).add(query.columns.lastname.lower.like(args[1] + '%')));' +
		'  result = databaseManager.getDataSetByQuery(query,100);' +
		'} else if (realValue != null) {' +
		'  // TODO think about caching this result. can be called often!' +
		'  // real object not found in the current list, return 1 row with display,realvalue that will be added to the current list' +
		'  // dont return a complete list in this mode because that will be added to the list that is already there' +
		'  args = [realValue];' +
		'  query.result.add(query.columns.firstname.concat(' ').concat(query.columns.lastname)).add(query.columns.employeeid).' +
		'  root.where.add(query.columns.employeeid.eq(args[0]));' +
		'  result = databaseManager.getDataSetByQuery(query,1);' +
		'}' +
		'return result;' +
		'}');
var vlist = solutionModel.newValueList('vlist', JSValueList.CUSTOM_VALUES);
vlist.globalMethod = listProvider;

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the value list.

It is relevant when the "useTableFilter" property is set.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.dataSource = 'db:/example_data/valuelists';
vlist.setDisplayDataProviderIds('valuelist_data');
vlist.setReturnDataProviderIds('valuelist_data');
vlist.useTableFilter = true;
vlist.name = 'two';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	relationName

Table Row (tr)

id	name

Table Cell (td)
relationName

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the relation that is used for loading data from the database.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var rel = solutionModel.newRelation('parent_to_child', 'db:/example_data/parent_table', 'db:/example_data/child_table', JSRelation.INNER_JOIN);
rel.newRelationItem('parent_table_id', '=', 'child_table_parent_id');

var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.dataSource = 'db:/example_data/parent_table';
vlist.relationName = 'parent_to_child';
vlist.setDisplayDataProviderIds('child_table_text');
vlist.setReturnDataProviderIds('child_table_text');

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	separator

Table Row (tr)

id	name

Table Cell (td)
separator

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

A String representing the separator that should be used when multiple
display dataproviders are set, when the value list has the type set to
database values.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	serverName

Table Row (tr)

id	name

Table Cell (td)
serverName

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the database server that is used for loading the values when
the value list has the type set to database values.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setFallbackValueList-JSValueList

Table Row (tr)

id	name

Table Cell (td)
setFallbackValueList

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSValueList} vl

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	sortOptions

Table Row (tr)

id	name

Table Cell (td)
sortOptions

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Sort options that are applied when the valuelist loads its data
from the database.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	tableName

Table Row (tr)

id	name

Table Cell (td)
tableName

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The name of the database table that is used for loading the values when
the value list has the type set to database values.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	useTableFilter

Table Row (tr)

id	name

Table Cell (td)
useTableFilter

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Flag that tells if the name of the valuelist should be applied as a filter on the
'valuelist_name' column when retrieving the data from the database.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.dataSource = 'db:/example_data/valuelists';
vlist.setDisplayDataProviderIds('valuelist_data');
vlist.setReturnDataProviderIds('valuelist_data');
vlist.useTableFilter = true;
vlist.name = 'two';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	valueListType

Table Row (tr)

id	name

Table Cell (td)
valueListType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The type of the valuelist. Can be either custom values or database values.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

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	getDisplayDataProviderIds

Table Row (tr)

id	name

Table Cell (td)
getDisplayDataProviderIds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object[]

Span

style	font-weight: bold;

getDisplayDataProviderIds

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an array of the dataproviders that will be used to display the valuelist value.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object[] - An array of Strings representing the names of the display dataproviders.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text', 'parent_table_id');
vlist.setReturnDataProviderIds('parent_table_text');
var dispDP = vlist.getDisplayDataProviderIds();
for (var i=0; i<dispDP.length; i++)
	application.output(dispDP[i]);
var retDP = vlist.getReturnDataProviderIds();
for (var i=0; i<retDP.length; i++)
	application.output(retDP[i]);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getReturnDataProviderIds

Table Row (tr)

id	name

Table Cell (td)
getReturnDataProviderIds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object[]

Span

style	font-weight: bold;

getReturnDataProviderIds

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an array of the dataproviders that will be used to define the valuelist value that is saved.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object[] - An array of Strings representing the names of the return dataprovider.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.DATABASE_VALUES);
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text', 'parent_table_id');
vlist.setReturnDataProviderIds('parent_table_text');
var dispDP = vlist.getDisplayDataProviderIds();
for (var i=0; i<dispDP.length; i++)
	application.output(dispDP[i]);
var retDP = vlist.getReturnDataProviderIds();
for (var i=0; i<retDP.length; i++)
	application.output(retDP[i]);

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getUUID

Table Row (tr)

id	name

Table Cell (td)
getUUID

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

UUID

Span

style	font-weight: bold;

getUUID

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns the UUID of the value list

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

UUID

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
application.output(vlist.getUUID().toString());

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setDisplayDataProviderIds

Table Row (tr)

id	name

Table Cell (td)
setDisplayDataProviderIds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setDisplayDataProviderIds

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.

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

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setDisplayDataProviderIds-String

Table Row (tr)

id	name

Table Cell (td)
setDisplayDataProviderIds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setDisplayDataProviderIds

Span
(dataprovider1)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} dataprovider1 - The first display dataprovider.

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

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setDisplayDataProviderIds-String_String

Table Row (tr)

id	name

Table Cell (td)
setDisplayDataProviderIds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setDisplayDataProviderIds

Span
(dataprovider1, dataprovider2)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} dataprovider1 - The first display dataprovider.
{String} dataprovider2 - The second display dataprovider.

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

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setDisplayDataProviderIds-String_String_String

Table Row (tr)

id	name

Table Cell (td)
setDisplayDataProviderIds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setDisplayDataProviderIds

Span
(dataprovider1, dataprovider2, dataprovider3)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} dataprovider1 - The first display dataprovider.
{String} dataprovider2 - The second display dataprovider.
{String} dataprovider3 - The third display dataprovider.

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

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setReturnDataProviderIds

Table Row (tr)

id	name

Table Cell (td)
setReturnDataProviderIds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setReturnDataProviderIds

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.

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

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setReturnDataProviderIds-String

Table Row (tr)

id	name

Table Cell (td)
setReturnDataProviderIds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setReturnDataProviderIds

Span
(dataprovider1)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} dataprovider1 - The first return dataprovider.

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

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setReturnDataProviderIds-String_String

Table Row (tr)

id	name

Table Cell (td)
setReturnDataProviderIds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setReturnDataProviderIds

Span
(dataprovider1, dataprovider2)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} dataprovider1 - The first return dataprovider.
{String} dataprovider2 - The second return dataprovider.

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

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setReturnDataProviderIds-String_String_String

Table Row (tr)

id	name

Table Cell (td)
setReturnDataProviderIds

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setReturnDataProviderIds

Span
(dataprovider1, dataprovider2, dataprovider3)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} dataprovider1 - The first return dataprovider.
{String} dataprovider2 - The second return dataprovider.
{String} dataprovider3 - The third return dataprovider.

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

var vlist = solutionModel.newValueList('options', JSValueList.CUSTOM_VALUES);
vlist.valueListType = JSValueList.DATABASE_VALUES; // Change the type to database values.
vlist.dataSource = 'db:/example_data/parent_table';
vlist.setDisplayDataProviderIds('parent_table_text');
vlist.setReturnDataProviderIds('parent_table_text', 'parent_table_id');
vlist.separator = ' ## ';
vlist.sortOptions = 'parent_table_text desc';

Table Row (tr)

class	lastDetailRow

Table Cell (td)

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

DATABASE_VALUES

name

DATABASE_VALUES

des

sIndent

Constant to set the valueListType of a JSValueList.
Sets the value list to use values loaded from a database.
Also used in solutionModel.newValueList(...) to create new valuelists

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

EMPTY_VALUE_ALWAYS

name

EMPTY_VALUE_ALWAYS

des

sIndent

Constant to set/get the addEmptyValue property of a JSValueList.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

EMPTY_VALUE_NEVER

name

EMPTY_VALUE_NEVER

des

sIndent

Constant to set/get the addEmptyValue property of a JSValueList.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

propertyservoy sDetail2100%height:30px2Property DetailsaddEmptyValuename

addEmptyValue

des

sIndent

Property that tells if an empty value must be shown next to the items in the value list.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

customValues

name

customValues

des

sIndent

A string with the elements in the valuelist. The elements
can be separated by linefeeds (custom1
custom2), optional with realvalues ((custom1|1
custom2|2)).

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

dataSource

name

dataSource

des

sIndent

Compact representation of the names of the server and table that
are used for loading the data from the database.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

displayValueType

name

displayValueType

des

sIndent

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

fallbackValueList

name

fallbackValueList

des

sIndent

Gets or sets the fallback valuelist.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

globalMethod

name

globalMethod

des

sIndent

The global method of the valuelist is called to fill in or adjust the values of the valuelist.
The method returns a dataset with one or two columns, first column is the display value, second column is real value(if present).
The valuelist will be filled in with the dataset data. If second column is not present real value and display value will be the same.
The method has to handle three different scenarios:
 1. 'displayValue' parameter is not null, this parameter should be used to filter the list of values(in a typeahead fashion)
 2. 'realValue' parameter is specified, that means value was not found in current list, so must be specified manually.
 In this case method should return only one row in the dataset, with the missing value, that will be added to the valuelist
 3. 'realValue' and 'displayValue' are both null , in this case the complete list of values should be returned.

Scenario 1 and 3 will completely replace any older results in the valuelist while scenario 2 will append results.

In find mode the record will be the FindRecord which is just like a normal JSRecord (DataRecord) it has the same properties (column/dataproviders) but doesnt have its methods (like isEditing())

The last argument is rawDisplayValue which contains the same text as displayValue but without converting it to lowercase.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

lazyLoading

name

lazyLoading

des

sIndent

A property special for NGClient and GlobalValuelist to only query the global valuelist when it is needed.
This flag has to be set both on valuelist and in component spec, on the valuelist property.

IMPORTANT: Usage of real & display values is not fully supported with lazy loading. Don't set lazy load if your method returns both real and display values
This is because very likely we do need directly the display value for the given real to dispaly its value..

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

name

des

sIndent

The name of the value list.

It is relevant when the "useTableFilter" property is set.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

realValueType

name

realValueType

des

sIndent

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

relationName

name

relationName

des

sIndent

The name of the relation that is used for loading data from the database.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

separator

name

separator

des

sIndent

A String representing the separator that should be used when multiple
display dataproviders are set, when the value list has the type set to
database values.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

serverName

name

serverName

des

sIndent

The name of the database server that is used for loading the values when
the value list has the type set to database/table values.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setFallbackValueList

name

setFallbackValueList

des

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

sortOptions

name

sortOptions

des

sIndent

Sort options that are applied when the valuelist loads its data
from the database.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

tableName

name

tableName

des

sIndent

The name of the database table that is used for loading the values when
the value list has the type set to database/table values.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

useTableFilter

name

useTableFilter

des

sIndent

Flag that tells if the name of the valuelist should be applied as a filter on the
'valuelist_name' column when retrieving the data from the database.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

valueListType

name

valueListType

des

sIndent

The type of the valuelist. Can be either custom values or database values.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetDisplayDataProviderIdsname

getDisplayDataProviderIds()

des

sIndent

Returns an array of the dataproviders that will be used to display the valuelist value.

ret

Returns

sIndent

An array of Strings representing the names of the display dataproviders.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getReturnDataProviderIds

name

getReturnDataProviderIds()

des

sIndent

Returns an array of the dataproviders that will be used to define the valuelist value that is saved.

ret

Returns

sIndent

An array of Strings representing the names of the return dataprovider.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getUUID

name

getUUID()

des

sIndent

Returns the UUID of the value list

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setDisplayDataProviderIds

name

setDisplayDataProviderIds()

des

sIndent

Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setDisplayDataProviderIds

name

setDisplayDataProviderIds(dataprovider1)

des

sIndent

Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.

prs

Parameters

sIndent

dataprovider1

The first display dataprovider.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setDisplayDataProviderIds

name

setDisplayDataProviderIds(dataprovider1, dataprovider2)

des

sIndent

Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.

prs

Parameters

sIndent

dataprovider1

The first display dataprovider.

dataprovider2

The second display dataprovider.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setDisplayDataProviderIds

name

setDisplayDataProviderIds(dataprovider1, dataprovider2, dataprovider3)

des

sIndent

Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.

prs

Parameters

sIndent

dataprovider1

The first display dataprovider.

dataprovider2

The second display dataprovider.

dataprovider3

The third display dataprovider.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setReturnDataProviderIds

name

setReturnDataProviderIds()

des

sIndent

Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setReturnDataProviderIds

name

setReturnDataProviderIds(dataprovider1)

des

sIndent

Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.

prs

Parameters

sIndent

dataprovider1

The first return dataprovider.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setReturnDataProviderIds

name

setReturnDataProviderIds(dataprovider1, dataprovider2)

des

sIndent

Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.

prs

Parameters

sIndent

dataprovider1

The first return dataprovider.

dataprovider2

The second return dataprovider.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setReturnDataProviderIds

name

setReturnDataProviderIds(dataprovider1, dataprovider2, dataprovider3)

des

sIndent

Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.

prs

Parameters

sIndent

dataprovider1

The first return dataprovider.

dataprovider2

The second return dataprovider.

dataprovider3

The third return dataprovider.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 25

New Version Current

Key

CUSTOM_VALUES

DATABASE_VALUES

EMPTY_VALUE_ALWAYS

EMPTY_VALUE_NEVER

addEmptyValue

customValues

dataSource

fallbackValueList

globalMethod

name

relationName

separator

serverName

setFallbackValueList

sortOptions

tableName

useTableFilter

valueListType

getDisplayDataProviderIds

getReturnDataProviderIds

getUUID

setDisplayDataProviderIds

setDisplayDataProviderIds

setDisplayDataProviderIds

setDisplayDataProviderIds

setReturnDataProviderIds

setReturnDataProviderIds

setReturnDataProviderIds

setReturnDataProviderIds

DATABASE_VALUES

EMPTY_VALUE_ALWAYS

EMPTY_VALUE_NEVER

addEmptyValue

customValues

dataSource

displayValueType

fallbackValueList

globalMethod

lazyLoading

name

realValueType

relationName

separator

serverName

setFallbackValueList

sortOptions

tableName

useTableFilter

valueListType

getDisplayDataProviderIds()

getReturnDataProviderIds()

getUUID()

setDisplayDataProviderIds()

setDisplayDataProviderIds(dataprovider1)

setDisplayDataProviderIds(dataprovider1, dataprovider2)

setDisplayDataProviderIds(dataprovider1, dataprovider2, dataprovider3)

setReturnDataProviderIds()

setReturnDataProviderIds(dataprovider1)

setReturnDataProviderIds(dataprovider1, dataprovider2)

setReturnDataProviderIds(dataprovider1, dataprovider2, dataprovider3)