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

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

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

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

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

Supported Clients

SmartClient,WebClient,NGClient,MobileClient

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

relationName

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

Returns

String

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

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