Child pages
  • ValueList

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Divcache
Div
iddescription
HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)addEmptyValue
styleindexdisplay:none

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.

true
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. Table Row (tr)

Table Cell (td)
String
Table Cell (td)customValues
A string with the elements in the valuelist. Table Row (tr)
Table Cell (td)
String
Table Cell (td)dataSource
Compact representation of the names of the server and table that
are used for loading the data from the database. Table Row (tr)
Table Cell (td)
String
Table Cell (td)deprecated
Gets the deprecate info for this element Table Row (tr)
Table Cell (td)
Number
Table Cell (td)encapsulation
The encapsulation mode of this persist. Table Row (tr)
Table Cell (td)
String
Table Cell (td)name
Table Cell (td)
String
Table Cell (td)relationName
Valuelist.The name of the value list. Table Row (tr)The name of the relation that is used for loading data from the database. Table Row (tr)
Table Cell (td)
String
Table Cell (td)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
Table Cell (td)sortOptions
database values. Table Row (tr)
Table Cell (td)
String
Sort options that are applied when the valuelist loads its data
from the database. Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)useTableFilter
Flag that tells if the name of the valuelist should be applied as a filter on the
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)valueListType
'valuelist_name' column when retrieving the data from the database.The type of the valuelist.table

id

propertyclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col
Table Head (thead) Table Row (tr)styleheight:30px; Table Head (th)colspan2Property Details Table Body (tbody)ididaddEmptyValue Table Row (tr)nametd

addEmptyValue

Table Row (tr)id

des Table Cell (td) DivclasssIndentProperty that tells if an empty value must be shown next to the items in the value list. Table Row (tr)idtdret

Returns

divsIndentclients

class

Supported Clients

sIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idcustomValues
Table Row (tr)
idname
Table Cell (td)

customValues

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow 
customValuesname

customValues

dessIndentA string with the elements in the valuelist. The elements

can be separated by linefeeds (custom1
custom2), optional with realvalues ((custom1|1
Table Row (tr)id custom2|2)).ret

Table Cell (td)

Returns

divsIndentclients

class Div

classsIndent

Supported Clients

sIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddataSource
Table Row (tr)
idname
Table Cell (td)

dataSource

Table Row (tr)
iddes
Table Cell (td)SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow 
dataSourcename

dataSource

dessIndentCompact representation of the names of the server and table that

are used for loading the data from the database. Table Row (tr)idret

Table Cell (td)

Returns

divsIndentclients

class Table Body (tbody)

iddeprecated
Table Row (tr)
idname
Table Cell (td)

deprecated

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent

Supported Clients

sIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow 
deprecatedname

deprecated

dessIndentGets the deprecate info for this element
Table Row (tr)idtdret

Returns

divsIndentclients

class

Supported Clients

sIndent
String - the deprecate info for this element or null if it is not deprecated
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idencapsulation
Table Row (tr)
idname
Table Cell (td)

encapsulation

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow 
encapsulationname

encapsulation

dessIndentThe encapsulation mode of this
persistValuelist. 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 both scripting and designer from any other context except the form itself. Available in designer for the same module.
Table Row (tr)idmodule) - 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)tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
Number - the encapsulation mode/level of the persist.
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idname
Table Row (tr)
idname
Table Cell (td)

name

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow 
namename

name

dessIndentThe name of the value list.
It is relevant when the "useTableFilter" property is set. Table Row (tr)idtdret

Returns

divsIndentclients

class

Supported Clients

sIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idrelationName
Table Row (tr)
idname
Table Cell (td)

relationName

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow 
relationNamename

relationName

dessIndentThe name of the relation that is used for loading data from the database.
Table Row (tr)idtdret

Returns

divsIndentclients

class

Supported Clients

sIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idseparator
Table Row (tr)
idname
Table Cell (td)

separator

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow 
separatorname

separator

dessIndentA String representing the separator that should be used when multiple

display dataproviders are set, when the value list has the type set to
Table Row (tr)id database values.tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsortOptions
Table Row (tr)
idname
Table Cell (td)

sortOptions

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow 
sortOptionsname

sortOptions

dessIndentSort options that are applied when the valuelist loads its data

from the database. Table Row (tr)idtdret

Returns

divsIndentclients

class

Supported Clients

sIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iduseTableFilter
Table Row (tr)
idname
Table Cell (td)

useTableFilter

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow 
useTableFiltername

useTableFilter

dessIndentFlag that tells if the name of the valuelist should be applied as a filter on the

Table Row (tr)id 'valuelist_name' column when retrieving the data from the database.ret

Table Cell (td)

Returns

divsIndentclients

class

Supported Clients

sIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idvalueListType
Table Row (tr)
idname
Table Cell (td)

valueListType

Table Row (tr)
iddes
Table Cell (td) Div
classsIndent
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow 
valueListTypename

valueListType

dessIndentThe type of the valuelist. Can be either custom values or database values.
Table Row (tr)idret

Table Cell (td)

Returns

divsIndentclients

classNumber Table Row (tr)

classlastDetailRow
Table Cell (td) 

Supported Clients

sIndent
SmartClient,WebClient,NGClient,MobileClientsam

Sample

sIdentjavascript
lastDetailRow