Child pages
  • JSValueList

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;3Constants SummaryConstant to set the valueListType of a JSValueList.Constant to set the valueListType of a JSValueList.Constant to set/get the addEmptyValue property of a JSValueList.Constant to set/get the addEmptyValue property of a JSValueList.

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.Compact representation of the names of the server and table that are used for loading the data from the database.Gets or sets the fallback valuelist.A global method that provides the data for the valuelist.The name of the value list.The name of the relation that is used for loading data from the database.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.The name of the database server that is used for loading the values when the value list has the type set to database/table values.voidSort options that are applied when the valuelist loads its data from the database.The name of the database table that is used for loading the values when the value list has the type set to database/table values.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.

servoy sSummary12%30%58%height: 30px;3Methods SummaryReturns an array of the dataproviders that will be used to display the valuelist value.Returns an array of the dataproviders that will be used to define the valuelist value that is saved.Returns the UUID of the value listvoidSet the display dataproviders.voidSet the display dataproviders.voidSet the display dataproviders.voidSet the display dataproviders.voidSet the return dataproviders.voidSet the return dataproviders.voidSet the return dataproviders.voidSet the return dataproviders.

constantservoy sDetail2100%height:30px2Constants DetailsCUSTOM_VALUESname

CUSTOM_VALUES

dessIndent
Constant to set the valueListType of a JSValueList.
Sets the value list to use a custom list of values.
Also used in solutionModel.newValueList(...) to create new valuelists
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowDATABASE_VALUESname

DATABASE_VALUES

dessIndent
Constant to set the valueListType of a JSValueList.
Sets the value list to use values loaded from a database.
Also used in solutionModel.newValueList(...) to create new valuelists
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
EMPTY_VALUE_ALWAYSname

EMPTY_VALUE_ALWAYS

dessIndent
Constant to set/get the addEmptyValue property of a JSValueList.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
EMPTY_VALUE_NEVERname

EMPTY_VALUE_NEVER

dessIndent
Constant to set/get the addEmptyValue property of a JSValueList.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

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

Sample

sIdentjavascript
lastDetailRow
displayValueTypename

displayValueType

dessIndentret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
fallbackValueListname

fallbackValueList

dessIndent
Gets or sets the fallback valuelist.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
globalMethodname

globalMethod

dessIndent
A global method that provides the data for the valuelist. The global method must provided the data
as a JSDataSet.

It is called when the valuelist needs data, it has 3 modes.
real and display params both null: return the whole list
only display is specified, called by a typeahead, return a filtered list
only real value is specified, called when the list doesnt contain the real value for the give record value, this will insert this value into the existing list.

In find mode the record with be the FindRecord which is just like a normal JSRecord (DataRecord) it has the same properties (column/dataproviders) but doesnt have its methods (like isEditing())

The last argument is rawDisplayValue which contains the same text as displayValue but without converting it to lowercase.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
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

dessIndentret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
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
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
sam

Sample

sIdentjavascript
lastDetailRow
serverNamename

serverName

dessIndent
The name of the database server that is used for loading the values when
the value list has the type set to database/table values.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setFallbackValueListname

setFallbackValueList

dessIndentclients

Supported Clients

sIndentSmartClient,WebClient,NGClient
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
sam

Sample

sIdentjavascript
lastDetailRow
tableNamename

tableName

dessIndent
The name of the database table that is used for loading the values when
the value list has the type set to database/table values.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
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
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
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetDisplayDataProviderIdsname

getDisplayDataProviderIds()

dessIndent
Returns an array of the dataproviders that will be used to display the valuelist value.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetReturnDataProviderIdsname

getReturnDataProviderIds()

dessIndent
Returns an array of the dataproviders that will be used to define the valuelist value that is saved.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getUUIDname

getUUID()

dessIndent
Returns the UUID of the value list
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDisplayDataProviderIdsname

setDisplayDataProviderIds()

dessIndent
Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDisplayDataProviderIdsname

setDisplayDataProviderIds(dataprovider1)

dessIndent
Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.
prs

Parameters

sIndentdataprovider1The first display dataprovider.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDisplayDataProviderIdsname

setDisplayDataProviderIds(dataprovider1, dataprovider2)

dessIndent
Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.
prs

Parameters

sIndentdataprovider1The first display dataprovider.dataprovider2The second display dataprovider.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setDisplayDataProviderIdsname

setDisplayDataProviderIds(dataprovider1, dataprovider2, dataprovider3)

dessIndent
Set the display dataproviders. There can be at most 3 of them, combined with the return dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be displayed
by the valuelist.
prs

Parameters

sIndentdataprovider1The first display dataprovider.dataprovider2The second display dataprovider.dataprovider3The third display dataprovider.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setReturnDataProviderIdsname

setReturnDataProviderIds()

dessIndent
Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setReturnDataProviderIdsname

setReturnDataProviderIds(dataprovider1)

dessIndent
Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.
prs

Parameters

sIndentdataprovider1The first return dataprovider.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setReturnDataProviderIdsname

setReturnDataProviderIds(dataprovider1, dataprovider2)

dessIndent
Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.
prs

Parameters

sIndentdataprovider1The first return dataprovider.dataprovider2The second return dataprovider.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setReturnDataProviderIdsname

setReturnDataProviderIds(dataprovider1, dataprovider2, dataprovider3)

dessIndent
Set the return dataproviders. There can be at most 3 of them, combined with the display dataproviders.
The values taken from these dataproviders, in order, separated by the separator, will be returned
by the valuelist.
prs

Parameters

sIndentdataprovider1The first return dataprovider.dataprovider2The second return dataprovider.dataprovider3The third return dataprovider.
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow