Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sSummary12%30%58%height: 30px;3Property SummaryProperty that tells if an empty value must be shown next to the items in the value list.A string with the elements in the valuelist.This is the dataprovider selected in the fist list of dataproviders when a table or related valuelist is selected.This is the dataprovider selected in the last list of dataproviders when a table or related valuelist is selected.This is the dataprovider selected in the last 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 deprecate info for this elementThe type of the display value if this is a global or custom valuelist, servoy needs to know this for formatting purposesThe 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 special for NGClient and GlobalValuelist to only query the global valuelist 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.

propertyservoy sDetail2100%height:30px2Property DetailsaddEmptyValuename

addEmptyValue

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowcustomValuesname

customValues

dessIndent
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

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
dataProviderID1name

dataProviderID1

dessIndent
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
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
dataProviderID2name

dataProviderID2

dessIndent
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
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
dataProviderID3name

dataProviderID3

dessIndent
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
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
dataSourcename

dataSource

dessIndent
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

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
deprecatedname

deprecated

dessIndent
Gets the deprecate info for this element
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
displayValueTypename

displayValueType

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
encapsulationname

encapsulation

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
fallbackValueListname

fallbackValueList

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
lazyLoadingname

lazyLoading

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
namename

name

dessIndent
The name of the value list.

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
realValueTypename

realValueType

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
relationNamename

relationName

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
returnDataProvidersname

returnDataProviders

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
separatorname

separator

dessIndent
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

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
showDataProvidersname

showDataProviders

dessIndent
Gets the showDataProvider.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
sortOptionsname

sortOptions

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
useTableFiltername

useTableFilter

dessIndent
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

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
valueListTypename

valueListType

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow