Child pages
  • ValueList

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Rev: 1382015639154
Div
styledisplay: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.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

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
Property 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
The name of the value list.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
relationName
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
database values.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
sortOptions
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
'valuelist_name' column when retrieving the data from the database.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
valueListType
The type of the valuelist.



HTML Table
idproperty
classservoy sDetail
Colgroup Tag
column
Col
padding
colspan
0px
2
width100%
Col
Table Head (thead)
1
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan
2
Property Details
Table Body (tbody)
idaddEmptyValue
Table Row (tr)
idname
Table Cell (td)

addEmptyValue

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Property that tells if an empty value must be shown next to the items in the value list.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
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
A string with the elements in the valuelist. The elements
can be separated by linefeeds (custom1
custom2), optional with realvalues ((custom1|1
custom2|2)).
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
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)
Div
classsIndent
Compact 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

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
iddeprecated
Table Row (tr)
idname
Table Cell (td)

deprecated

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the deprecate info for this element
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
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

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)
idret
Table Cell (td)

Returns

Div
classsIndent
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

The name of the value list.

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

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
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
The name of the relation that is used for loading data from the database.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
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
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)
idret
Table Cell (td)

Returns

Div
classsIndent
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
Sort options that are applied when the valuelist loads its data
from the database.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
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
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)
idret
Table Cell (td)

Returns

Div
classsIndent
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
The type of the valuelist. Can be either custom values or database values.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)