Supported Clients
SmartClient
WebClient
NGClient
MobileClient

Property Summary
Number
addEmptyValue
Property that tells if an empty value must be shown next to the items in the value list.
String
comment

String
customValues
A string with the elements in the valuelist.
String
dataProviderID1
This is the dataprovider selected in the fist list of dataproviders when a table or related valuelist is selected.
String
dataProviderID2
This is the dataprovider selected in the last list of dataproviders when a table or related valuelist is selected.
String
dataProviderID3
This is the dataprovider selected in the last list of dataproviders when a table or related valuelist is selected.
String
dataSource
Compact representation of the names of the server and table that are used for loading the data from the database.
String
deprecated
Gets the deprecate info for this element
Number
displayValueType
The type of the display value if this is a global or custom valuelist, servoy needs to know this for formatting purposes
Number
encapsulation
The encapsulation mode of this Valuelist.
Number
fallbackValueList
If the valuelist only displays the "active" values that a user can choose, but you still need to be able to show also old values, then a fallback valuelist should be set.
Boolean
lazyLoading
A property special for NGClient and GlobalValuelist to only query the global valuelist when it is needed.
String
name
The name of the value list.
Number
realValueType
The type of the real value if this is a global or custom valuelist, servoy needs to know this so it can check if the types match on the record it is binded to.
String
relationName
The name of the relation that is used for loading data from the database.
Number
returnDataProviders
Which of the dataprovers should be used as the return dataprovider, so set back into the records dataprovider.
String
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 database values.
Number
showDataProviders
Gets the showDataProvider.
String
sortOptions
Sort options that are applied when the valuelist loads its data from the database.
Boolean
useTableFilter
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.
Number
valueListType
The type of the valuelist.

Property Details

addEmptyValue

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

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

comment

Returns

String

Supported Clients

SmartClient,WebClient,NGClient

Sample

customValues

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

dataProviderID1

This is the dataprovider selected in the fist list of dataproviders when a table or related valuelist is selected.
This dataprovide can be marked as a display and/or return value

Returns

String Returns a String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

dataProviderID2

This is the dataprovider selected in the last list of dataproviders when a table or related valuelist is selected.
This dataprovide can be marked as a display and/or return value

Returns

String Returns a String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

dataProviderID3

This is the dataprovider selected in the last list of dataproviders when a table or related valuelist is selected.
This dataprovide can be marked as a display and/or return value

Returns

String Returns a String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

dataSource

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

deprecated

Gets the deprecate info for this element

Returns

String the deprecate info for this element or null if it is not deprecated

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

displayValueType

The type of the display value if this is a global or custom valuelist, servoy needs to know this for formatting purposes

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

encapsulation

The encapsulation mode of this Valuelist. The following can be used:

- Public (available in both scripting and designer from any module)
- Module Scope - available in both scripting and designer but only in the same module.

Returns

Number the encapsulation mode/level of the persist.

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

fallbackValueList

If the valuelist only displays the "active" values that a user can choose, but you still need to be able to show also old values, then a fallback valuelist should be set.
 So that there is a backup list for getting a display value for a real value that is not in the normal valuelist anymore.

Returns

Number the valueback valuelist id.

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

lazyLoading

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

Returns

Boolean

Supported Clients

NGClient

Sample

name

The name of the value list.

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

realValueType

The type of the real value if this is a global or custom valuelist, servoy needs to know this so it can check if the types match on the record it is binded to.

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

relationName

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

returnDataProviders

Which of the dataprovers should be used as the return dataprovider, so set back into the records dataprovider.

Returns

Number Returns a int

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

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
database values.

Returns

String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

showDataProviders

Gets the showDataProvider.

Returns

Number Returns a int

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

sortOptions

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

Returns

String

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

useTableFilter

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.

Returns

Boolean

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample

valueListType

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

Returns

Number

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

Sample