Value List
Overview
A value list is an object from the data layer that is used by the UI (components) to provide selection lists and translations of internal values to display values. Value lists can be static, meaning their contents do not change, or dynamic, where they can be updated or modified over time.
They can be used for example in components such as dropdown menus, radio button groups or checkbox lists.
Properties Summarized
Property that tells if an empty value must be shown next to the items in the value list.
Additional information, such as programmer notes about this model object's purpose.
A string with the elements in the valuelist.
This is the dataprovider selected in the first list of dataproviders, when a table or related valuelist is selected.
This is the dataprovider selected in the second list of dataproviders, when a table or related valuelist is selected.
This is the dataprovider selected in the third list of dataproviders, when a table or related valuelist is selected.
Compact representation of the names of the server and table that are used for loading the data from the database.
Gets the deprecation info for this element.
The type of the display value if this is a global or custom valuelist, servoy needs to know this for formatting purposes.
The encapsulation mode of this Valuelist.
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.
A property, specific for NG & Titanium clients with GlobalValuelist - it helps to query/call the global valuelist method only when it is needed.
The name of the value list.
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.
The name of the relation that is used for loading data from the database.
Which of the dataprovers should be used as the return dataprovider, so set back into the records dataprovider.
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.
Gets the showDataProvider.
Sort options that are applied when the valuelist loads its data from the database.
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.
The type of the valuelist.
Properties Detailed
addEmptyValue
Property that tells if an empty value must be shown next to the items in the value list.
comment
Additional information, such as programmer notes about this model object's purpose.
customValues
A string with the elements in the valuelist. The elements can be separated by line feeds: custom1 custom2
Elements can optionally have real values: custom1|1 custom2|2
The (custom) values can be given via a global scope method instead, if the valuelist type is of global method type...
Sample
dataProviderID1
This is the dataprovider selected in the first list of dataproviders, when a table or related valuelist is selected. This dataprovider can be marked as a display and/or a return value.
Sample
dataProviderID2
This is the dataprovider selected in the second list of dataproviders, when a table or related valuelist is selected. This dataprovider can be marked as a display and/or a return value.
Sample
dataProviderID3
This is the dataprovider selected in the third list of dataproviders, when a table or related valuelist is selected. This dataprovider can be marked as a display and/or a return value.
Sample
dataSource
Compact representation of the names of the server and table that are used for loading the data from the database.
Sample
deprecated
Gets the deprecation info for this element.
Sample
displayValueType
The type of the display value if this is a global or custom valuelist, servoy needs to know this for formatting purposes.
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.
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. It works as a backup list for getting a display value for a real value that is not in this normal/main valuelist anymore.
Sample
lazyLoading
A property, specific for NG & Titanium clients with GlobalValuelist - it helps to query/call the global valuelist method only when it is needed.
This flag has to be set both on the valuelist and in component specification (.spec file), on the valuelist property, in order for it to work correctly (so the developer decides if a valuelist provides this option, and the component decides if it uses this feature or not).
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 limitation is in place because, very likely in that case, we do need directly the display value for the current component's data (real value) in order to display it in UI...
name
The name of the value list.
It is relevant when the "useTableFilter" property is set.
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.
Sample
relationName
The name of the relation that is used for loading data from the database.
Sample
returnDataProviders
Which of the dataprovers should be used as the return dataprovider, so set back into the records dataprovider.
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.
Sample
showDataProviders
Gets the showDataProvider.
sortOptions
Sort options that are applied when the valuelist loads its data from the database.
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.
valueListType
The type of the valuelist. Can be one of:
custom values
global method
database values
table based
relation based
Last updated
Was this helpful?