Common Properties

Class

The class property allows you to specify a cascading style sheet (CSS) class for the widget. This class will be applied to the widget in the browser and the widget will get the corresponding styling. The class should be a class from the theme that is used in the project. It overrules the default styling of the widget.

Note that the styling is applied in the following order:

  1. Default styling defined by the theme the project uses.
  2. The ‘Class’ property of the widget.
  3. The ‘Style’ property of the widget.

Style

The style property allows you to specify additional CSS styling. If a class is also specified, this styling is applied after the class.

background-color:blue; This will result in a blue background

Data Source Properties

Attribute (path)

The attribute (path) property specifies the attribute’s value that will be displayed in this column. It can be an attribute of the grid entity, or it can be an attribute of an associated entity, in which case we speak of an attribute path. The path can follow multiple associations of type reference, and at the end (optionally) one of type reference set. If you show a reference set in a column the values will be separated by a comma.

Formatting Properties

Enumeration format (only for attributes of type Enumeration)

A column connected to an attribute of type enumeration can show its contexts as text (default) or as image.

ValueDescription
TextShow the caption text of the enumeration.
ImageShow the image of the enumeration value.

Decimal precision (only for numeric attributes)

The precision of a value is defined the number of digits that is used to express that value. This property indicates the number of decimal places (the number of digits following the decimal point).

Default value: 2

Group digits (only for numeric attributes)

For ease of reading, numbers with many digits before the decimal separator may be divided into groups using a delimiter. This property defines whether the end user will see these groups, or not.

Default value: False

Date format (only for attributes of type DateTime)

The date format determines whether the date part, the time part or both are shown. How the date and time parts are formatted depends on the localization of the user using the application.

Possible values: ‘Date’, ‘Time’, ‘Date and time’ and ‘Custom’.

Default value: Date

If you choose ‘Custom’ as the date format (see above) the custom date format determines the way date and/or time are formatted. The custom date format is a string that follows the rules in this table,

SymbolNo.ExampleDescription
G1ADEra
y1..n2010Year
M1..209Month
M3Sept
M4September
w1..227Week of Year
D1..393Day of Year
a1AMAM or PM
h1..211Hour (1-12)
H1..213Hour (0-23)
k1..210Hour (1-24)
K1..20Hour (0-11)
m1..259Minute, use one or two for zero padding
s1..212Second, use one or two for zero padding
FormatExample output
EEEE d MMMM yyy G, h:mm a ss'sTuesday 29 March 2011 AD, 1:37 PM 48s
h:mm a1:37 PM
yyy D KK:mm2011 88 01:26
EEEE MMMM d yyyTuesday March 29 2011
EEE, MMM d, ''yyWed, Jul 4, '01

General Properties

Caption

The caption of a column is the text that appears as a header above the rows. This is a translatable text. See Translatable Texts.

Editable

The editable property indicates whether the values of the column will be editable in-line, i.e. without opening a page with a data view. In-line editing allows the data grid to behave like you would expect from a spreadsheet application.

Aggregate function

The values in a column can be aggregated in several ways. The aggregate function determines the way in which the values are aggregated. The aggregate will be shown at the bottom of the column that precedes by the aggregate caption (see below).

ValueDescription
NoneDo not aggregate the values in the column.
AverageShow the average of the values.
MinimumShow the smallest value.
MaximumShow the largest value.
SumShow the sum of the values.
CountShow the count of the values.

Note that all objects will be taken into account, and not just the ones on the current page.

Aggregate caption

The aggregate caption is the text that appears in front of the computed value. This is a translatable text. See Translatable Texts.

‘Total’ could be an aggregate caption for a column that shows the sum of the values.

Show tooltip

This property determines whether the tooltip page is shown as the mouse is hovered over this column. The tooltip page can be configured on the Data grid.

Default value: False