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'


Property Summary
Number
addEmptyValue
Property that tells if an empty value must be shown next to the items in the value list.
String
customValues
A string with the elements in the valuelist.
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
encapsulation
The encapsulation mode of this persist.
String
name
The name of the value list.
String
relationName
The name of the relation that is used for loading data from the database.
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.
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

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

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

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

encapsulation

The encapsulation mode of this persist. The following can be used/checked:

- Public (not a separate option - if none of the below options are selected)
- Hide in scripting; Module Scope - not available in scripting from any other context except the form itself. Available in designer for the same module.
- Module Scope - available in both scripting and designer but only in the same module.
- Hide Dataproviders (checked by default)
- Hide Foundset (checked by default)
- Hide Controller (checked by default)
- Hide Elements (checked by default)

Returns
Number - the encapsulation mode/level of the persist.

name

The name of the value list.

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

Returns
String

relationName
The name of the relation that is used for loading data from the database.
Returns
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.
Returns
String

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

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

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