Page History

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'

Divcache

styleindex	display:none

Div

id	description

HTML Table

id

class

servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)addEmptyValue

true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

id

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

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.

Compact representation of the names of the server and table that

deprecated

are used for loading the data from the database.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)

Gets the deprecate info for this element

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)encapsulation

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

The encapsulation mode of this

persist. Table Row (tr)

Table Cell (td)
String

Table Cell (td)name

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

. Table Row (tr)

Table Cell (td)
String

Table Cell (td)relationName

.

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

. Table Row (tr)

Table Cell (td)
String

Table Cell (td)separator

.

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

. Table Row (tr)

Table Cell (td)
String

Table Cell (td)sortOptions

.

Gets the showDataProvider.

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

valueListType

'valuelist_name' column when retrieving the data from the database.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)

The type of the valuelist.

HTML Table

propertyclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col

Table Head (thead) Table Row (tr)style

height:30px

; Table Head (th)colspan

2

Property Details

Table Body (tbody)idid

addEmptyValue

Table Row (tr)

name

td

addEmptyValue

Table Row (tr)id

des

Table Cell (td) Divclass

sIndent

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

tr

idtdretReturnsdivsIndentclientsclass
Supported Clients
sIndentNumber Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)id customValues
 Table Row (tr)
id name
 Table Cell (td)
customValues
 Table Row (tr)id des
 Table Cell (td) Divclass sIndent
A string with the elements in the valuelist. The elements
can be separated by linefeeds (custom1
custom2), optional with realvalues SmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowcustomValuesnamecustomValuesdessIndentA string with the elements in the valuelist. The elements
can be separated by linefeeds (custom1
custom2), optional with realvalues ((custom1|1
 Table Body (tbody)
id dataSource
 Table Row (tr)
id name
 Table Cell (td)
dataSource
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
Compact representation of the names of the server and table that
are used for loading the data from the database.
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
String
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id deprecated
 Table Row (tr)
id name
 Table Cell (td)
deprecated
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
Gets the deprecate info for this element
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
String - the deprecate info for this element or null if it is not deprecated
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id encapsulation
 Table Row (tr)
id name
 Table Cell (td)
encapsulation
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
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)
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
Number - the encapsulation mode/level of the persist.
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id name
 Table Row (tr)
id name
 Table Cell (td)
name
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
The name of the value list.
It is relevant when the "useTableFilter" property is set.
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
String
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id relationName
 Table Row (tr)
id name
 Table Cell (td)
relationName
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
The name of the relation that is used for loading data from the database.
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
String
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id separator
 Table Row (tr)
id name
 Table Cell (td)
separator
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
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.
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
String
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id sortOptions
 Table Row (tr)
id name
 Table Cell (td)
sortOptions
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
Sort options that are applied when the valuelist loads its data
from the database.
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
String
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id useTableFilter
 Table Row (tr)
id name
 Table Cell (td)
useTableFilter
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
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.
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
Boolean
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)id valueListType
 Table Row (tr)
id name
 Table Cell (td)
valueListType
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
The type of the valuelist. Can be either custom values or database values.
 Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
Number
 Table Row (tr)class lastDetailRow
 Table Cell (td) 
custom2|2)). Table Row (tr)
id ret
 Table Cell (td)
Returns
 Div
class sIndent
String
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowdataProviderID1namedataProviderID1dessIndentThis 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 valueretReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowdataProviderID2namedataProviderID2dessIndentThis 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 valueretReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowdataProviderID3namedataProviderID3dessIndentThis 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 valueretReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowdataSourcenamedataSourcedessIndentCompact representation of the names of the server and table that
are used for loading the data from the database.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowdeprecatednamedeprecateddessIndentGets the deprecate info for this elementretReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowdisplayValueTypenamedisplayValueTypedessIndentThe type of the display value if this is a global or custom valuelist, servoy needs to know this for formatting purposesretReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowencapsulationnameencapsulationdessIndentThe 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.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowfallbackValueListnamefallbackValueListdessIndentIf 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.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowlazyLoadingnamelazyLoadingdessIndentA 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.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRownamenamenamedessIndentThe name of the value list.

It is relevant when the "useTableFilter" property is set.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowrealValueTypenamerealValueTypedessIndentThe 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.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowrelationNamenamerelationNamedessIndentThe name of the relation that is used for loading data from the database.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowreturnDataProvidersnamereturnDataProvidersdessIndentWhich of the dataprovers should be used as the return dataprovider, so set back into the records dataprovider.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowseparatornameseparatordessIndentA 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.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowshowDataProvidersnameshowDataProvidersdessIndentGets the showDataProvider.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowsortOptionsnamesortOptionsdessIndentSort options that are applied when the valuelist loads its data
from the database.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowuseTableFilternameuseTableFilterdessIndentFlag 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.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRowvalueListTypenamevalueListTypedessIndentThe type of the valuelist. Can be either custom values or database values.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClient,MobileClientsamSample
sIdentjavascriptlastDetailRow

Child pages

Versions Compared

Old Version 15

New Version 23

Key

addEmptyValue

customValues

customValues

dataSource

deprecated

encapsulation

name

relationName

separator

sortOptions

useTableFilter

valueListType

dataProviderID1

dataProviderID2

dataProviderID3

dataSource

deprecated

displayValueType

encapsulation

fallbackValueList

lazyLoading

name

realValueType

relationName

returnDataProviders

separator

showDataProviders

sortOptions

useTableFilter

valueListType