Shared Properties

This section describes properties of Data Table component shared with inherited components.

Enable Search

If enabled, allows searching the event log.

Variable Name:	enableSearch
Records:	1

Record Format:

Field Name	Field Type	Field Description
enableSearch	Boolean	Enable Search

Search Placeholder

A message displayed when there is no other text in the search field.

Variable Name:	searchPlaceholder
Records:	1

Record Format:

Field Name	Field Type	Field Description
searchPlaceholder	String	Search Placeholder

Enable Advanced Search

Enables advanced filtering options for the component.

Variable Name:	enableAdvancedSearch
Records:	1

Record Format:

Field Name	Field Type	Field Description
enableAdvancedSearch	Boolean	Enable Advanced Search

Advanced Search by Calculated Fields

Applies only to Class Data Tables. When enabled, allows advanced filtering options to filter values generated by the Table Format Naming Expression, and other calculated fields. Enabling this option can result in performance degradation if system resources are not sufficient for the number of class instances and calculated fields being filtered.

Variable Name:	classInstanceAdvancedSearchCalculatedFields
Records:	1

Record Format:

Field Name	Field Type	Field Description
classInstanceAdvancedSearchCalculatedFields	Boolean	Advanced Search by Calculated Fields

Read Only

When enabled, the user is prevented from editing values in the data table.

Variable Name:	readOnly
Records:	1

Record Format:

Field Name	Field Type	Field Description
readOnly	Boolean	Read Only

Generate Row Added Events

Enables generation of Row Added events.

Variable Name:	generateRowAddedEvents
Records:	1

Record Format:

Field Name	Field Type	Field Description
generateRowAddedEvents	Boolean	Generate Row Added Events

Generate Row Removed Events

Enables generation of Row Removed events.

Variable Name:	generateRowRemovedEvents
Records:	1

Record Format:

Field Name	Field Type	Field Description
generateRowRemovedEvents	String	Generate Row Removed Events

Generate Cell Updated Events

Enables generation of Cell Updated events.

Variable Name:	generateCellUpdatedEvents
Records:	1

Record Format:

Field Name	Field Type	Field Description
generateCellUpdatedEvents	Boolean	Generate Cell Updated Events

Multiple Column Sorting

If enabled, allows using sorting by more than one data table column.

Variable Name:	multipleSorting
Records:	1

Record Format:

Field Name	Field Type	Field Description
multipleSorting	Boolean	Multiple Column Sorting

This flag indicates if data table's toolbar will be displayed.

Variable Name:	showToolbar
Records:	1

Record Format:

Field Name	Field Type	Field Description
showToolbar	Boolean	Show Toolbar

This flag determines whether the context menu will be displayed when a right-click is performed on a cell of the data table.

Variable Name:	enableContextMenu
Records:	1

Record Format:

Field Name	Field Type	Field Description
enableContextMenu	Boolean	Enable Context Menu

Show Import Button

When enabled, the import button will be displayed to the user.

Variable Name:	showImportButton
Records:	1

Record Format:

Field Name	Field Type	Field Description
showImportButton	Boolean	Show Import Button

Show Export Button

When enabled, the export button will be displayed to the user.

Variable Name:	showExportButton
Records:	1

Record Format:

Field Name	Field Type	Field Description
showExportButton	Boolean	Show Export Butto

Items Per Page

Defines the default number of data table rows to display on a single page.

Variable Name:	rowsPerPage
Records:	1

Record Format:

Field Name	Field Type	Field Description
rowsPerPage	Integer	Items Per Page

Custom ‘Row Per Page’ Selection Values

This property allows specifying custom values for the list selecting number of records on every page.

Variable Name:	customPaginatorValues
Records:	0..unlimited

Record Format:

Field Name	Field Type	Field Description
value	Integer	Value. Number of items per page.

Show 'Items per Page' Selector

This flag indicates if 'Items per Page' selector will be displayed.

Variable Name:	showRowsPerPageSelector
Records:	1

Record Format:

Field Name	Field Type	Field Description
showRowsPerPageSelector	Boolean	Show 'Items Per Page' Selector

‘Items per Page’ Selector Type

Defines the type of 'Items per Page' selector. This property has two selection values

Combo Box - the selector will be displayed as dropdown list with selection values
Button Group - the selector will be displayed as the set of buttons

Variable Name:	rowsPerPageSelectorType
Records:	1

Record Format:

Field Name	Field Type	Field Description
rowsPerPageSelectorType	String	'Items Per Page' Selector Type

Even Selected Row Color

The color indicated by this variable will be applied to even-numbered rows of the data table when they are selected.

Variable Name:	evenSelectedRowColor
Records:	1

Record Format:

Field Name	Field Type	Field Description
evenSelectedRowColor	Color	Even Selected Row Color

Odd Selected Row Color

The color indicated by this variable will be applied to odd-numbered rows of the data table when they are selected.

Variable Name:	oddSelectedRowColor
Records:	1

Record Format:

Field Name	Field Type	Field Description
oddSelectedRowColor	Color	Odd Selected Row Color

Fixed Format

If enabled, component will display an empty data table with the format specified in the Format property and any data in the Data Table property will be ignored.

Variable Name:	fixedFormat
Records:	1

Record Format:

Field Name	Field Type	Field Description
fixedFormat	Boolean	Fixed Format

Format

The custom format of the data table. Details about data table format completely described in the corresponding topic.

Variable Name:	format
Records:	1

Record Format:

Field Name	Field Type	Field Description
format	Data Table	Format

Record ID Column Name

Must be a String that exactly matches one of the column names of the data table of the Data Table property. When provided, the indicated column will be treated as the column containing the unique key for each row of the table. Each value in the indicated column must be unique for each row of the data table.

Variable Name:	idColumn
Records:	1

Record Format:

Field Name	Field Type	Field Description
idColumn	String	Record ID Column Name

Selected Rows Expression

Expression to indicate which rows of the data table to display as selected. Expression is evaluated for every row of the data table, if the evaluation result is True, the row is displayed as selected, otherwise the row will be displayed as not selected. Expression is evaluated every time the data table is changed.

Variable Name:	selectedRowsExpression
Records:	1

Record Format:

Field Name	Field Type	Notes
selectedRowsExpression	String	Must evaluate to a boolean value. Evaluated for every row of the data table. Expression is evaluated every time the table is changed. If expression evaluates to `True`, the current row is displayed as selected. Otherwise, the currently evaluated row is displayed as not selected.
		Selected Rows Expression Expression Resolution Environment:
		Default Data Table	Component Data Table
		Default Context	None.
		Default Row	Currently processed row of the default table.
		Environment Variables	Standard variables only.

Column Settings

This property contains different settings allowing to configure visual representation and behavior of Data Table columns.

Variable Name:	columnsSettings
Records:	0..unlimited

Record Format:

Field Name	Field Type	Field Description
name	String	Name. The column name.
fixed	String	Fixed Column. If not Unset, allows to fix the column on the Left or Right side of the table, effectively changing column's position. A fixed column ignores horizontal scrolling.
headerTextBehavior	String	Header Text Behavior. Controls how column header is displayed if header text does not fit into the default column width: Expand Column allows the column width to expand enough to accommodate the header text in a single line. Ellipsis truncates header text Word Wrap maintains column width by expanding column height and displaying header text on multiple lines. Columns with no text and no content will be displayed with the minimum column width of 75 pixels.
wordBreak	String	Word Break. Defines line breaks mode for the column's regular cells: Break All allows breaking text at any character Break Word allows breaking at the end of any word Don't Break completely prohibits breaking text into several lines
visibleLength	Integer	Visible Length. Defines the maximum number of characters of a string to display in the renderer. Full value will be displayed in the mouse-over tooltip.
textAlignHorizontal	String	Cell Text Horizontal Alignment. Defines horizontal position of the text in the column cell.
textAlignHeaderHorizontal	String	Header Text Horizontal Alignment. Defines horizontal position of the text in the column header.
textAlignVertical	String	Cell Text Vertical Alignment. Defines vertical position of the text in the column cell.
textAlignHeaderVertical	String	Header Text Vertical Alignment. Defines vertical position of the text in the column header.
sorter	Boolean	Sorting. Enables sorting by the column.
filtering	Boolean	Search. Enables search by column data.
filterTable	Data Table	Filter Table. Allows to define custom search criteria for the column if Search is enabled for it. A list of options has two columns: Value - string representation of cell value to be filtered Description - a custom description of the above value
width	Integer	Width. Column width, in pixels.
visibility	Boolean	Visibility. Indicate whether the column should be displayed to the user.
index	Integer	Index. Specify the initial order of the columns, with `0` being the leftmost column.
loading	String	Loading. Choose how the column will be loaded: Eager - Default value. Column data is loaded immediately with the initial table render. Lazy - Column data is loaded after the initial table render, potentially improving table loading speed. Column width must be defined in order to use this option.

Height to the Appearance of Scrolling

Maximum height in pixels from which vertical scroll is enabled in the data table's cell.

Variable Name:	heightScrollEnabled
Records:	1

Record Format:

Field Name	Field Type	Field Description
heightScrollEnabled	Integer	Maximum Height Without Vertical Scrolling

Enable Row Selection

If enabled, allows selecting rows using checkboxes.

Variable Name:	checkRows
Records:	1

Record Format:

Field Name	Field Type	Field Description
checkRows	Boolean	Enable Row Selection

Column Enabling Row Read-only Mode

Name of a Boolean-type column false values in that will make table rows read-only.

Variable Name:	columnToDefineRowLock
Records:	1

Record Format:

Field Name	Field Type	Field Description
columnToDefineRowLock	String	Column Enabling Row Read-only Mode

Name of a Boolean-type column in the table. Kebab menu will be active only in rows where this column value is True.

Variable Name:	columnToDefineKebabLock
Records:	1

Record Format:

Field Name	Field Type	Field Description
columnToDefineKebabLock	String	Column Enabling Kebab Menu

Allow Column Resizing

If enabled, allows columns resizing.

Variable Name:	resizableColumn
Records:	1

Record Format:

Field Name	Field Type	Field Description
resizableColumn	Boolean	Allow Column Resizing

Row Removal Confirmation

If enabled, toolbar's Delete Row action will require confirmation.

Variable Name:	confirmActionDelete
Records:	1

Record Format:

Field Name	Field Type	Field Description
confirmActionDelete	Boolean

Row Addition Confirmation

If enabled, toolbar's Add Row action will require confirmation.

Variable Name:	confirmActionAdd
Records:	1

Record Format:

Field Name	Field Type	Field Description
confirmActionAdd	Boolean

Filter Icon

Image for the filter icon.

Variable Name:	filterIcon
Records:	1

Record Format:

Field Name	Field Type	Field Description
imageType	Integer	Choose whether to use data from the imageData field or the imageURL field. 0 - Image Data 1 - URL
imageData	Data Block	Image data.
imageUrl	String	Image URL.

Search Icon

Image for the search icon.

Variable Name:	searchIcon
Records:	1

Record Format:

Field Name	Field Type	Field Description
imageType	Integer	Choose whether to use data from the imageData field or the imageURL field. 0 - Image Data 1 - URL
imageData	Data Block	Image data.
imageUrl	String	Image URL.

Enable Column Visibility

When enabled, displays a vertical kebab toolbar menu which displays a list of columns. User can check or uncheck columns from the list to show or hide columns.

Variable Name:	enableColumnVisibility
Records:	1

Record Format:

Field Name	Field Type	Field Description
enableColumnVisibility	Boolean	Enables/disables column visibility control menu.

Manually Configure Column Width

When enabled, the table will use the Width defined in the Column Settings property for each column. This can significantly improve performance, particularly for large tables, by reducing the time required to automatically calculate and adjust column widths.

A Width must be defined in the Column Settings property for every column in the table when enabling this property.

Variable Name:	manualConfigureColumnWidth
Records:	1

Record Format:

Field Name	Field Type	Field Description
manualConfigureColumnWidth	Boolean	Enables manual column width configuration using the widths specified in the Column Settings table.

Nested Records Settings

Properties to allow data from the Data Table property to be displayed as nested rows similar to the Custom Tree component. To correctly display nested data, the table data must contain a Record ID Column with a unique ID for each record and a Parent Record ID Column indicating the Record ID of a record’s parent record. Top level records have NULL specified in their Parent Record ID Column.

Variable Name:	treeRecordSettings
Records:	1

Record Format:

Field Name	Field Type	Field Description
idColumnName	String	Record ID Column Name
parentIdColumnName	String	Parent Record ID Column Name
indentSize	Integer	Indent Size
visibleChildren	Integer	Visible Children

Record Expansion Depth

Allows nested records to be automatically expanded to the indicated depth. Setting Record Expansion Depth to 1 will automatically open all child nodes of the top-level records, setting it to 2 will open all of the children’s child nodes, and so on.

Variable Name:	expansionDepth
Records:	1

Record Format:

Field Name	Field Type	Field Description
expansionDepth	Integer	Record Expansion Depth

Expanded Records ID

Controls which nested rows within the Data Table Editor are initially expanded upon rendering. This property accepts a list of IDs corresponding to the records (rows) you want to be displayed in an expanded state by default. Rows not included in this list will be initially collapsed, requiring action from a binding or user interaction to reveal their nested content.

Variable Name:	expandedRecordsId
Records:	1

Record Format:

Field Name	Field Type	Field Description
expandedRecordId	String	Record ID

Opened Switcher Image

Applied when Nested Records Settings are configured to display nested row data. The indicated image replaces the default Opened Switcher Image.

Variable Name:	openedSwitcherImage
Records:	1

Record Format:

Field Name	Field Type	Field Description
imageType	Integer	Type 0 to indicate Data 1 to indicate URL
imageData	Data Block	Image Data
imageUrl	String	Image URL

Closed Switcher Image

Applied when Nested Records Settings are configured to display nested row data. The indicated image replaces the default Closed Switcher Image.

Variable Name:	closedSwitcherImage
Records:	1

Record Format:

Field Name	Field Type	Field Description
imageType	Integer	Type 0 to indicate Data 1 to indicate URL
imageData	Data Block	Image Data
imageUrl	String	Image URL

If enabled, adds a kebab menu column with configurable buttons to the data table.

Variable Name:	additionalActionEnable
Records:	1

Record Format:

Field Name	Field Type	Field Description
additionalActionEnable	Boolean	Enable Kebab Menu

If enabled, additional buttons are shown right in the table cell instead of a drop-down kebab menu.

Variable Name:	additionalActionShowInRow
Records:	1

Record Format:

Field Name	Field Type	Field Description
additionalActionShowInRow	Boolean	Show Kebab Menu Items Inside Row

Kebab menu icon.

Variable Name:	additionalActionIcon
Records:	1

Record Format:

Field Name	Field Type	Field Description
imageType	Integer	Choose whether to use data from the imageData field or the imageURL field. 0 - Image Data 1 - URL
imageData	Data Block	Image data.
imageUrl	String	Image URL.

Width of kebab menu icon (or items, if Show Kebab Menu Items Inside Row is enabled) in pixels.

Variable Name:	additionalActionWidth
Records:	1

Record Format:

Field Name	Field Type	Field Description
additionalActionWidth	Integer	Kebab Menu Icon Width

This property allows to specify kebab menu items.

Variable Name:	additionalActionSettings
Records:	0..unlimited

Record Format:

Field Name	Field Type	Field Description
uid	String	UID. Item's unique ID.
desc	String	Description. Item description.
icon	Data Block	Icon. Image of the item in regular state.
iconHover	Data Block	Hover Icon. Image of the item in mouse hover state.
iconActive	Data Block	Active Icon. Image of the item in active (clicked) state.
buttonAction	String	Action. Defines which action will be executed for corresponding row by pressing the button. This property has several selection values: Edit. Starts editing current read-only row. Delete. Deletes current row. Cancel. Cancels editing of current row and discards changes. Apply. Stops editing of current row and applies changes.
confirm	Boolean	Confirmation. If enabled, item action will require confirmation.
confirmTitle	String	Confirmation Message. Text of confirmation message.

CSS style applied to kebab menu elements.

Variable Name:	additionalActionStyle
Records:	1

Record Format:

Field Name	Field Type	Field Description
additionalActionStyle	String	Kebab Menu Style

DPF_EXPORT_V5.8.8 / TIME_1743710551 / 2025-04-03 20:02:31 / STRLEN_61957 / STRLEN_HTML_71064

{VERSION}

Was this page helpful?

Shared Properties

Enable Search

Search Placeholder

Enable Advanced Search

Advanced Search by Calculated Fields

Read Only

Generate Row Added Events

Generate Row Removed Events

Generate Cell Updated Events

Multiple Column Sorting

Show Toolbar

Enable Context Menu

Show Import Button

Show Export Button

Items Per Page

Custom ‘Row Per Page’ Selection Values

Show 'Items per Page' Selector

‘Items per Page’ Selector Type

Even Selected Row Color

Odd Selected Row Color

Fixed Format

Format

Record ID Column Name

Selected Rows Expression

Column Settings

Height to the Appearance of Scrolling

Enable Row Selection

Column Enabling Row Read-only Mode

Column Enabling Kebab Menu

Allow Column Resizing

Row Removal Confirmation

Row Addition Confirmation

Filter Icon

Search Icon

Enable Column Visibility

Manually Configure Column Width

Nested Records Settings

Record Expansion Depth

Expanded Records ID

Opened Switcher Image

Closed Switcher Image

Enable Kebab Menu

Show Kebab Menu Items Inside Row

Kebab Menu Icon

Kebab Menu Icon Width

Kebab Menu Items

Kebab Menu Style