Field

The Field object is a multifunctional, editable input.

It supports various data types, providing flexibility for different input scenarios:

• Text (Default): A single-line text field for general input

• Multiline: A multi-line text field, suitable for longer descriptions or notes

• Date: date values

• Date and Time: combined date and time values

• Time: time values

• Keypad: a numeric keypad for code entry

• Select: presents a selection list of options

• Table: presents a table of rows and stores the selected row keys

The field value is sent as a command to the server:

• when the user changes it, if Auto Send it true

• when a button with submit action is pressed (sending multiple fields at once)

Tab moves focus to the next control, while Shift+Tab moves it to the previous control.

In a select list, Up and Down move through the options, Enter confirms the selection, and Escape closes the list.

Attributes

Common

ID

Sets the object's ID.

The ID identifies the object and is used to reference it in UISet actions, allowing to change its attributes dynamically.

The ID is not unique, it can be shared among multiple objects to quickly change a common attribute.

IDs can't be changed with a UISet action, but they can have a Value Binding assigned to them. Value Bindings on IDs allow an object to be dynamically attached to a set of attribute values.

E.g. the following Value Binding switches the ID of the object between mybutton1 and mybutton2 based on the value of the UISet button.address:

Value binding:

"mybutton" + ui('button', 'address')

UISet:

UISet('button', 'address', '1') switches the ID to mybutton1

UISet('button', 'address', '2') switches the ID to mybutton2

Position and Size

Position

Sets the object's position.

Attribute Values

Value	Description	Example
x<left>y<top>	Specify left/top coordinates in pixels.	x10y20

This attribute is available when parent's layout is neither "flex" nor "grid".

When parent's layout is neither "flex" nor "grid", this attribute defaults to x0y0.

Flex Grow

Specifies if the objects should grow to fill the available space.

Attribute Values

Value	Description
false	Default value. Objects do not grow to fill the available space.
true	Objects expand to fill the available space.

This attribute is available when parent's layout is "flex".

The default value is: false.

Flex Shrink

Specifies if the objects should shrink to fit the available space.

Attribute Values

Value	Description
false	Default value. Objects do not shrink to fit the available space.
true	Objects shrink to fit the available space.

This attribute is available when parent's layout is "flex".

The default value is: false.

Column

Specifies the starting column of the object inside a grid container.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Column index starting from 1.

This attribute is available when parent's layout is "grid".

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Column Span

Specifies how many grid columns the object spans.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Column span starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to 1.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Row

Specifies the starting row of the object inside a grid container.

Minimum value is 1.

Attribute Values

Value	Description
[empty]	Auto placement by the grid.
<int>	Row index starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to auto.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Row Span

Specifies how many grid rows the object spans.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Row span starting from 1.

This attribute is available when parent's layout is "grid".

When parent's layout is "grid", this attribute defaults to 1.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Width

Sets the object's width in pixels.

Minimum value is 50.

Height

Sets the object's height in pixels.

Minimum value is 22.

When type is "text", this attribute defaults to auto.

Field

Name

Specifies the name of the field, used to send a command to the server, along with the field's value as a parameter.

If the name starts with $, then the server will automatically set a variable with the same name as the command, containing the command's parameter.

Attribute Values

Value	Description	Example
<string>	Command name.
$[variable name]	A command name that sets a variable.	$myvar
$[variable name]!	A command name that sets a persistent variable.	$myvar!

By default, this attribute uses the id attribute.

Value

Specifies the field's value.

For more information on the format of the value, see the specific field type:

• Date fields
• Date and time fields use the format selected by DateTime Data Format
• Time and Time Interval fields
• Keypad fields
• Select fields
• Table fields

Default Value

Specifies the field's popup value when the field has no value. This allows a quick selection of a default value by pressing the Enter key or OK button.

For more information on the format of the value, see the specific field type:

• Date fields
• Time and Time Interval fields
• Keypad fields
• Select fields

This attribute is available when type is one of "date", "datetime", "time", "time-interval", or "keypad".

Placeholder

Specifies a short hint that describes the expected value of the field (e.g. a sample value or a short description of the expected format).

The short hint is displayed in the input field before the user enters a value.

Attribute Values

Value	Description
<string>	Placeholder text.

Read Only

Specifies if the field is read only.

Attribute Values

Value	Description
false	Default value. Can be written by the user.
true	Can't be written by the user (can still be changed with a uiSet).

The default value is: false.

Auto Send

Specifies whether the value is automatically sent on change or is sent through a button with submit action.

Attribute Values

Value	Description
auto	Default value. The value is sent only if there's no buttons with submit action in the same or a parent container.
true	The value is sent automatically on change.
false	The value is not automatically sent.

The default value is: auto.

Feedback

If feedback is enabled, when the action is performed, a loader is displayed until the server responds.

Also the action can't be performed again until the server responds.

Attribute Values

Value	Description
false	Default value. Feedback is disabled.
true	Feedback is enabled.

The default value is: false.

Change Delay

Sets the delay in milliseconds by which changes are detected. If the field is working in autosend mode, this value determines the delay between the last button press and the value being sent to the server.

Clear Button

Show a clear button that clears the field's value.

Attribute Values

Value	Description
true	Show the clear button when there's any value set.
false	Default value. Hide the clear button.

When type is "text", this attribute defaults to true.

Type

Type

Specifies the type of the field.

Attribute Values

Value	Description
text	Default value. Single line text field.
multiline	Multiline text field.
date	Date field.
datetime	Date and time field.
time	Time field.
time-interval	Time interval field.
keypad	Keypad field.
select	Select field.
table	Table field.

The default value is: text.

Min

Specifies the minimum value allowed.

Attribute Values

Value	Description
<string>	Minimum value.

This attribute is available when type is "keypad".

Max

Specifies the maximum value allowed.

Attribute Values

Value	Description
<string>	Maximum value.

This attribute is available when type is "keypad".

Digits

Specifies the number of digits allowed.

Attribute Values

Value	Description
auto	Any number of digits.
<int>	Maximum number of digits.

This attribute is available when type is "keypad".

Decimals

Specifies the number of decimals allowed.

Attribute Values

Value	Description
<int>	Number of decimals.

This attribute is available when type is "keypad".

When type is "keypad", this attribute defaults to 0.

Label

Specifies a label.

Attribute Values

Value	Description
<string>	Label.

This attribute is available when type is "keypad".

Data Mode

Specifies the mode of the data.

Attribute Values

Value	Description
items	Default value. Data is set with the field's item or row attributes.
list	Available only for select fields. Data is a list of comma-separated values. Set in the List attribute.
datasource	Data is set by a linked datasource.

This attribute is available when type is one of "select" or "table".

The default value is: items.

Datasource ID

Specifies the ID of the datasource.

The datasource keys are used as item values.

Attribute Values

Value	Description
<string>	ID of the datasource.

This attribute is available when (type=='select' or type=='table')and (datamode=='datasource').

Item Data Map

Specifies how to map datasource columns to the properties displayed by each list item.

This attribute is available when type is 'select'and (datamode=='datasource').

Label Data Name

Specifies the name of the column containing the label.

Attribute Values

Value	Description
<string>	Name of the column containing the label.

This attribute is available when type is "table" and datamode is "datasource".

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Multi

Specifies if the field allows selecting multiple items or rows.

Attribute Values

Value	Description
false	Default value. Single selection.
true	Multiple selection.

This attribute is available when type is one of "select" or "table".

The default value is: false.

Filter

Displays an input field for filtering the items. After typing a value in the field or setting the Filter Value attribute, any item that does not match the input will be hidden. A match occurs when the filter value is found anywhere within any item's fields ('value', 'label', etc).

Attribute Values

Value	Description
true	Display the filter field.
false	Default value. Hides the filter field.

This attribute is available when type is one of "select" or "table".

The default value is: false.

Filter Placeholder

Specifies a short hint that is displayed in the filter field before the user enters a value. Describes the expected value of an input field (e.g. a sample value or a short description of the expected format)

Attribute Values

Value	Description
<string>	A short hint.

This attribute is available when (type=='select' or type=='table')and (filter=='true').

Filter Value

Specifies a string used as filter value. It's applied even if the filter field is hidden.

Attribute Values

Value	Description	Example
<string>	The filter string.	Jan 2015

This attribute is available when type is one of "select" or "table".

Popup Width

Specifies the width of the select or table popup.

Attribute Values

Value	Description
auto	Default value. Select popup is wide enough to fit the content, while table popup uses its default width.
<int>	Width in pixels.

This attribute is available when type is one of "select" or "table".

When type is one of "select" or "table", this attribute defaults to auto.

Popup Height

Specifies the height of the table popup.

Attribute Values

Value	Description
<int>	Height in pixels.

This attribute is available when type is "table".

When type is "table", this attribute defaults to 300.

Sanitize Value

Specified one or more sanitization options to apply to the field's value before sending it to the server.

Attribute Values

Value	Description
trim	Removes leading and trailing whitespaces and line breaks.
carriage-return	Removes carriage returns.
non-printable	Removes non-printable characters.
lowercase	Converts the value to lowercase.
uppercase	Converts the value to uppercase.

This attribute is available when type is "text" or type is "multiline" or (type is "select" and freeinput is "true").

Step

Specifies the step of the time picker, referred to the smallest unit of time that can be selected.

E.g. if the smallest unit is minutes and step is set to 15, the time picker will allow to select only times that are multiple of 15 minutes.

Attribute Values

Value	Description	Example
<int>	Step of the picker.	15

This attribute is available when type is "time".

Default behavior:

• When type is "time", this attribute defaults to 1.
• When type is "time-interval", this attribute defaults to 1.
• When type is "datetime", this attribute defaults to 1.

Precision

Specifies the precision of the time picker, the smallest unit of time that can be selected

Attribute Values

Value	Description
minute	Default value. Minute.
second	Second.
ms	Ms.

This attribute is available when type is "time".

Default behavior:

• When type is "time", this attribute defaults to minute.
• When type is "datetime", this attribute defaults to minute.

Time Value Options

Specifies additional value options, which appear as buttons.

Attribute Values

Value	Description	Example
<JSON array>	Array of JSON options, each with value and label properties.	[{"value":"+15m","label":"In 15 min"}]

This attribute is available when type is "time".

Default behavior:

• When interval is "false", this attribute defaults to [{"value":"*", "label":"- -"},{"value":"now", "label":"$now;"}].
• When interval is "true", this attribute defaults to [{"value":"*", "label":"- -"}].

Time Data Format

Specifies the data format, which determines how the value is parsed when received (through a UISet) or sent.

Attribute Values

Value	Description
extended	Default value. HH:mm:ss.SSSS Extended Format.
basic	HHmmssSSSS Basic Format.
timestamp	Unix Timestamp: Seconds since the Unix Epoch (January 1, 1970 00:00:00 GMT).

This attribute is available when type is "time".

The default value is: extended.

Time Display Format

Specifies the field's format.

Attribute Values

Value	Description	Example
<JSON object>	Format configuration object.	{"format":"time","timestyle":"medium","hourcycle":"h12"}

This attribute is available when type is "time".

Step

Specifies the step of the time picker, referred to the smallest unit of time that can be selected.

E.g. if the smallest unit is minutes and step is set to 15, the time picker will allow to select only times that are multiple of 15 minutes.

Attribute Values

Value	Description	Example
<int>	Step of the picker.	15

This attribute is available when type is "time-interval".

Default behavior:

• When type is "time", this attribute defaults to 1.
• When type is "time-interval", this attribute defaults to 1.
• When type is "datetime", this attribute defaults to 1.

Unit

Specifies the unit of the value.

E.g. Unit: hour, Max Precision: hour, Min Precision: second. 5:30 will be parsed as 5.5. Unit: second, Max Precision: hour, Min Precision: second. 5:30 will be parsed as 330.

Attribute Values

Value	Description
year	Year.
day	Day.
hour	Default value. Hour.
minute	Minute.
second	Second.
ms	Ms.

This attribute is available when type is "time-interval".

When type is "time-interval", this attribute defaults to hour.

Min Precision

Specifies the minimum precision of the time picker, the greatest unit of time that can be selected

Attribute Values

Value	Description
year	Year.
day	Day.
hour	Default value. Hour.
minute	Minute.
second	Second.
ms	Ms.

This attribute is available when type is "time-interval".

When type is "time-interval", this attribute defaults to hour.

Max Precision

Specifies the maximum precision of the time picker, the smallest unit of time that can be selected.

Attribute Values

Value	Description
year	Year.
day	Day.
hour	Hour.
minute	Default value. Minute.
second	Second.
ms	Ms.

This attribute is available when type is "time-interval".

When type is "time-interval", this attribute defaults to minute.

Negative Values

Specifies whether negative values are allowed in interval mode.

Attribute Values

Value	Description
false	Default value. Negative values are not allowed.
true	Negative values are allowed.

This attribute is available when type is "time-interval" and true.

The default value is: false.

Time Interval Value Options

Specifies additional value options, which appear as buttons.

Attribute Values

Value	Description	Example
<JSON array>	Array of JSON options, each with value and label properties.	[{"value":"+15m","label":"In 15 min"}]

This attribute is available when type is "time-interval".

Default behavior:

• When interval is "false", this attribute defaults to [{"value":"*", "label":"- -"},{"value":"now", "label":"$now;"}].
• When interval is "true", this attribute defaults to [{"value":"*", "label":"- -"}].
• When type is "time-interval", this attribute defaults to [{"value":"*", "label":"- -"}].

From Date

Specifies the earliest selectable date. Dates prior to this will not be selectable.

Uses the same syntax as Value.

Attribute Values

Value	Description	Example
<string>	Minimum selectable date.	2020-12-31
<string>	Minimum selectable date using the same syntax as Value.	now-1w

This attribute is available when type is "date".

Default behavior:

• When dataformat is "extended", this attribute defaults to 1981-01-01.
• When dataformat is "basic", this attribute defaults to 19810101.
• When dataformat is "timestamp", this attribute defaults to 0.
• When type is "date", this attribute defaults to 1981-01-01.

To Date

Specifies the latest selectable date. Selection of dates beyond this point is not permitted.

Uses the same syntax as Value.

Attribute Values

Value	Description	Example
<string>	Maximum selectable date.	2028-12-31
<string>	Maximum selectable date using the same syntax as Value.	now+1w

This attribute is available when type is "date".

Default behavior:

• When dataformat is "extended", this attribute defaults to 2028-12-31.
• When dataformat is "basic", this attribute defaults to 20281231.
• When dataformat is "timestamp", this attribute defaults to 4102444800.
• When type is "date", this attribute defaults to 2028-12-31.

Date Value Options

Specifies additional value options, which appear as buttons.

Attribute Values

Value	Description	Example
<JSON array>	Array of JSON options, each with value and label properties.	[{"value":"+1w","label":"Next Week"}]

This attribute is available when type is "date".

When type is "date", this attribute defaults to [{"value":"*", "label":"- -"},{"value":"now", "label":"$today;"}].

Date Data Format

Specifies the data format, which determines how the value is parsed when received (through a UISet) or sent.

Attribute Values

Value	Description
extended	Default value. YYYY-MM-DD ISO 8601 Extended Format.
basic	YYYYMMDD ISO 8601 Basic Format.
timestamp	Unix Timestamp: Seconds since the Unix Epoch (January 1, 1970 00:00:00 GMT).

This attribute is available when type is "date".

The default value is: extended.

Date Display Format

Specifies the field's format.

Attribute Values

Value	Description	Example
<JSON object>	Format configuration object.	{"format":"date","datestyle":"custom","day":"2-digit","month":"short","year":"numeric"}

This attribute is available when type is "date".

Precision

Specifies the smallest selectable time unit.

Attribute Values

Value	Description
hour	Hour.
minute	Default value. Minute.
second	Second.
ms	Ms.

This attribute is available when type is "datetime".

Default behavior:

• When type is "time", this attribute defaults to minute.
• When type is "datetime", this attribute defaults to minute.

From Date

Specifies the earliest selectable date using Data Format.

This attribute is available when type is "datetime".

Default behavior:

• When dataformat is "extended", this attribute defaults to 1981-01-01.
• When dataformat is "basic", this attribute defaults to 19810101.
• When dataformat is "timestamp", this attribute defaults to 0.
• When type is "date", this attribute defaults to 1981-01-01.

To Date

Specifies the latest selectable date using Data Format.

This attribute is available when type is "datetime".

Default behavior:

• When dataformat is "extended", this attribute defaults to 2028-12-31.
• When dataformat is "basic", this attribute defaults to 20281231.
• When dataformat is "timestamp", this attribute defaults to 4102444800.
• When type is "date", this attribute defaults to 2028-12-31.

Step

Specifies the step of the smallest selectable time unit.

This attribute is available when type is "datetime".

Default behavior:

• When type is "time", this attribute defaults to 1.
• When type is "time-interval", this attribute defaults to 1.
• When type is "datetime", this attribute defaults to 1.

DateTime Data Format

Specifies the format used to parse and return the complete value.

Attribute Values

Value	Description
extended	Default value. YYYY-MM-DD HH:mm:ss.SSS ISO 8601 Extended Format.
basic	YYYYMMDDHHmmssSSS ISO 8601 Basic Format.
timestamp	Unix timestamp in milliseconds.

This attribute is available when type is "datetime".

When type is "datetime", this attribute defaults to extended.

DateTime Display Format

Specifies the field's format.

Attribute Values

Value	Description	Example
<JSON object>	Format configuration object.	{"format":"datetime","datestyle":"short","timestyle":"short"}

This attribute is available when type is "datetime".

Password

Hides the typed value, providing a way for the user to securely enter a password.

In toggle mode, a toggle button is displayed that allows the user to show the typed value.

Attribute Values

Value	Description
false	Default value. Typed value is not hidden.
true	Hide the typed value.
toggle	Show a toggle button that allows the user to show the typed value.
toggle-false	Show the toggle button, but show the typed value by default.

This attribute is available when type is one of "text" or "keypad".

The default value is: false.

Select

Items

Specifies the items.

Attribute Values

Value	Description	Example
<JSON array>	Array of list items.	[{"value":"kitchen","label":"Kitchen"}]

This attribute is available when type is 'select'and (datamode=='items').

List

Sets the items. An item with a label "---" (three hyphen-minus characters) is treated as a separator and its value is ignored.

Attribute Values

Value	Description	Example
<comma-separated list>	Items specified as a comma-separated list.	item1,item2,item3
<array>	Items specified as an array of strings.	["item1","item2","item3"]
<array of arrays>	Items specified as an array of arrays. Each item has an array of value and label.	[[1,"label1"],[2,"label2"],[3,"label3"]]
<array of arrays>	Items specified as an array of arrays. Each item has an array of values that can be recalled from the template attribute.	[[1,"label1","descr1"],[2,"label2","descr2"],[3,"label3","descr3"]]

This attribute is available when type is 'select'and (datamode=='list').

Values

This attribute is available when type is 'select'and (datamode=='list').

note

This attribute has been deprecated since ver. 4.0

Labels

This attribute is available when type is 'select'and (datamode=='list').

note

This attribute has been deprecated since ver. 4.0

Template

Specifies the template for the items.

The template can contain placeholders for the values of the items. The placeholders are specified as %0;, %1;, %2;, etc.

For example, if the template is %0; - %1;, %2; and the item is ["value", "label", "descr"], the result is value - label, descr.

If the template is not specified, the items' labels are displayed.

This attribute is available when type is "select".

Free Input

Specifies if the user can input a value that is not in the list.

Attribute Values

Value	Description
false	Default value. Only the items in the list can be selected.
true	The user can input a value that is not in the list.

This attribute is available when type is "select" and multi is "false".

The default value is: false.

Table

Table Items

Specifies the table's content with an array of arrays (rows, columns).

Attribute Values

Value	Description	Example
<array>	The array of rows and columns.	[[1,"one"],[2,"two"]]

This attribute is available when type is "table" and datamode is "items".

Columns

Specifies the table's columns.

Attribute Values

Value	Description	Example
<JSON array>	A JSON defining the columns.	[{"label":"Temperature","dataindex":"0","width":"120"}]

This attribute is available when type is "table".

Header

Displays the column header.

Attribute Values

Value	Description
false	False.
true	Default value. True.

This attribute is available when type is "table".

When type is "table", this attribute defaults to true.

Resizable Columns

Specifies if the columns can be resized by the user.

Attribute Values

Value	Description
false	Default value. Columns can't be resized.
true	Columns can be resized.
save	Columns can be resized and the new size is stored locally (in the localStorage of the browser).

This attribute is available when type is 'table'and (header!='false').

When type is 'table'and (header!='false'), this attribute defaults to false.

Sortable

Specifies if the table's rows are sortable by column. A command is sent if sort is specified in the Extra Commands attribute. This is useful for example when the table is showing only a subset of the data, and the server needs to know the current sort order to return the correct data.

Attribute Values

Value	Description
false	Default value. Rows can't be sorted.
true	Rows can be sorted.

This attribute is available when type is "table".

The default value is: false.

Sort Column

Specifies the index of a column to apply a local sort. Hidden columns are counted too.

Minimum value is 0.

Attribute Values

Value	Description
<int>	The index of the column to be sorted.

This attribute is available when type is 'table'and (sortable!='false').

When type is 'table'and (sortable!='false'), this attribute defaults to 0.

Sort Direction

If "Sort Column" is specified, specifies the sort order to apply a local sort.

Attribute Values

Value	Description
none	Default value. Not sorted.
asc	Sorted in ascending order.
desc	Sorted in descending order.

This attribute is available when type is 'table'and (sortable!='false').

The default value is: none.

Case Sensitive Sort

Specifies whether the local sort is case sensitive.

Attribute Values

Value	Description
false	Default value. Case insensitive.
true	Case sensitive.

This attribute is available when type is 'table'and (sortable=='local').

When type is 'table'and (sortable=='local'), this attribute defaults to false.

Show Item Count

Shows the item count in the bottom toolbar.

Attribute Values

Value	Description
true	Default value. Show.
false	Hide.

This attribute is available when type is "table".

When type is "table", this attribute defaults to true.

Show Top Bottom Buttons

Shows up/down buttons to scroll the table to the top/bottom.

Attribute Values

Value	Description
true	Show.
false	Default value. Hide.

This attribute is available when type is "table".

The default value is: false.

Column Filters

Displays input fields on each column that filter the items.

Attribute Values

Value	Description
false	Default value. Hides the columns' filter fields.
true	Display the columns' filter fields.
toggle	User can toggle the columns' filter fields visibility.

This attribute is available when type is "table".

The default value is: false.

Column Filters Value

Specifies the values of the per-column filters as a comma-separated list. Each value is matched to a declared column by position, so hidden columns still occupy a position in the list.

This attribute is applied even if the column filter fields are not visible. However, when filtering rows, only visible columns are evaluated. Values assigned to hidden columns are ignored. Matching is case-insensitive.

A column with Filter=false is always excluded from filtering. Individual columns can also specify whether the filter applies to the original or formatted value with the Filter column attribute.

Attribute Values

Value	Description
<comma-separated list>	List of filter values by declared column order. Hidden columns still take a position in the list, even though their values are not used for matching.

This attribute is available when type is "table".

Column Filters Preset

Specifies a hidden base filter that is applied before the user-defined filters. It is always active and is not shown in the column filter fields.

Like Column Filters Value, this attribute is a comma-separated list mapped by declared column position, so hidden columns still occupy a position in the list. Unlike Column Filters Value, preset filters are also applied to hidden columns. Matching is case-insensitive.

This makes it possible to restrict the table using data that is not shown to the user. A column with Filter=false is still excluded from preset filtering.

Attribute Values

Value	Description
<comma-separated list>	List of preset filter values by declared column order. Hidden columns still take a position in the list and their values are also used for matching.

This attribute is available when type is "table".

Row Height

Row height in pixels.

Attribute Values

Value	Description	Example
<integer>	Row height in pixels.	30

This attribute is available when type is "table".

When type is "table", this attribute defaults to 26.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Borders

Displays vertical and/or horizontal borders on every cell.

Attribute Values

Value	Description
none	Default value. No borders.
vertical	Vertical borders.
horizontal	Horizontal borders.
both	Both vertical and horizontal borders.

This attribute is available when type is "table".

The default value is: none.

Striped

Adds zebra-striping to rows.

Attribute Values

Value	Description
false	Default value. False.
true	True.

This attribute is available when type is "table".

The default value is: false.

Highlight Rows

Highlights rows on mouse over. Not available with touch devices.

Attribute Values

Value	Description
false	Default value. No higlight.
true	Highlight on mouse over.

This attribute is available when type is "table".

The default value is: false.

Highlight Selected Rows

Highlights selected rows.

Attribute Values

Value	Description
false	Default value. No higlight.
true	Highlight selected rows.

This attribute is available when type is "table".

The default value is: false.

Validation

Required

Specifies if the field is required when submitting multiple fields with a submit button. If true, an empty/null value is considered not valid. When there are non valid fields, the submit button focuses the first non valid field instead of sending data to the server, to prompt the user to fill in the required fields.

Attribute Values

Value	Description
false	Default value. The field is not required.
true	The field is required.

The default value is: false.

Mask

Specifies an input mask for the field. Supported slots are 0 for digits, a for letters, A for uppercase letters, n for alphanumeric characters, N for uppercase alphanumeric characters, x for hexadecimal digits, X for uppercase hexadecimal digits and * for any character. Use [ and ] to make part of the mask optional. Use \ to escape the next character and treat it as a literal.

When no placeholder is specified, the field shows the mask as underscores with any literal separators. The mask fills only the editable slots, blocks extra characters, and validates only when all slots are filled. The mask defines the structure, while Allowed Characters applies an additional filter to the characters typed into mask slots. A character must satisfy both the mask slot and the Allowed Characters regular expression, if specified. Validate Value is checked on the final formatted value.

E.g. *[***]/*[*]/*[*] with Allowed Characters set to [0-9*] allows values like 2026/3/4 or */3/4. E.g. AA000AA already restricts input by structure, so Allowed Characters is usually only needed for extra restrictions. When no font family is specified, masked fields default to Roboto Mono, monospace.

Attribute Values

Value	Description
0000/00/00	Four digits for year, two for month and two for day.
00/00/0000	Two digits for day, two for month and four for year.
0000/0[0]/0[0]	Year always uses four digits, month and day accept one or two digits.
AA000AA	Two uppercase letters, three digits and two uppercase letters.
AAAAAA00A00A000A	Six uppercase letters, two digits, one uppercase letter, two digits, one uppercase letter, three digits and one uppercase letter.
NNNN-0000	Four uppercase alphanumeric characters, a dash and four digits.
#XXXXXX	A literal # followed by six uppercase hexadecimal digits.
<string>	Any mask pattern.

This attribute is available when type is "text" or type is "multiline" or (type is "select" and freeinput is "true" and ((type is "text" or ((type is "select" and freeinput is "true"))))).

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Allowed Characters

Specifies a regular expression that defines the characters allowed as input for the custom element. E.g. "[a-z]" will allow only lowercase letters.

It's applied to pasted values as well. When a mask is specified, this regular expression is applied only to the characters typed into the mask slots. Mask literals such as /, - or escaped characters are inserted by the mask and do not need to match the regular expression. This means Allowed Characters is often redundant when the mask already defines the needed character types, and is mainly useful for extra restrictions such as allowing * together with digits in a slot pattern like *[***]/*[*]/*[*]. Might not work on Android devices.

Attribute Values

Value	Description
[empty]	Default value. No validation, all keys are allowed.
[a-z]	Only lowercase letters.
[A-Z]	Only uppercase letters.
[0-9]	Only numbers.
[0-9a-zA-Z]	Only numbers and letters.
[^\s\p{C}]	Only printable characters.
<string>	Regular expression.

This attribute is available when type is "text" or type is "multiline" or (type is "select" and freeinput is "true").

Validate Value

Specifies a regular expression that the field's value must match.

Attribute Values

Value	Description
[empty]	Default value. No validation, any input is valid.
[a-z]+	Only lowercase letters.
[A-Z]+	Only uppercase letters.
[a-zA-Z]+	Only letters.
[0-9]+	Only numbers.
[0-9a-zA-Z]+	Only numbers and letters.
<string>	Any regular expression.

This attribute is available when type is "text" or type is "multiline" or (type is "select" and freeinput is "true").

Min Length

Specifies the minimum number of characters required for the field's validation.

Attribute Values

Value	Description
<int>	Length in characters.

This attribute is available when type is "text" or type is "multiline" or (type is "select" and freeinput is "true").

Max Length

Specifies the maximum number of characters allowed in the field.

Attribute Values

Value	Description
<int>	Length in characters.

This attribute is available when type is "text" or type is "multiline" or (type is "select" and freeinput is "true").

Validate Tooltip

Specifies a custom validation tooltip to display when confirming the field value (on a submit button action or automatically in autosend mode). Displayed only if the current value doesn't match the validation criteria defined by the required, validate value and min length attributes.

Attribute Values

Value	Description
<string>	Validation tooltip.

This attribute is available when type is "text" or type is "multiline" or (type is "select" and freeinput is "true").

Layout

Prefix

Specifies a prefix to display before the field's value.

Attribute Values

Value	Description
<string>	Prefix text.

Suffix

Specifies a suffix to display after the field's value.

Attribute Values

Value	Description
<string>	Suffix text.

Icon

Specifies the field's icon image.

Attribute Values

Value	Description
<image>	Image path or icon id.

Secondary Icon

Specifies the field's secondary icon.

Attribute Values

Value	Description
<image>	Image path or icon id.

The default value is: auto.

Look

Specifies the field's look.

Attribute Values

Value	Description
filled	Default value. Filled look, with a solid background.
clear	Clear look, no background or border.
outlined	Outlined look, with a solid border.

The default value is: filled.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Background

Specifies the field's background color.

Attribute Values

Value	Description
<CSS Color>	Color.

Focus Tooltip

Specifies a description tooltip to display when focusing the field.

Attribute Values

Value	Description
<string>	Tooltip text.

Error

Error

Specifies that the field is in error state.

Attribute Values

Value	Description
false	Default value. Normal state.
true	Error state.

The default value is: false.

note

This attribute is live. It can't be set from the Project Editor, it needs to be set dynamically with a UISet.

Error Message

Specifies a custom error message to display when the field is in error state.

Attribute Values

Value	Description
<string>	Error message.

note

This attribute is live. It can't be set from the Project Editor, it needs to be set dynamically with a UISet.

Error Display

Specifies how the field error message is displayed when the field is in error state.

Attribute Values

Value	Description
tooltip	Default value. Display the error message as a tooltip.
inline	Display the error message under the field.

The default value is: tooltip.

Typography

Font Family

Specifies the font family.

Default behavior:

• When mask is not empty, this attribute defaults to Roboto Mono, monospace.
• Otherwise, this attribute defaults to default.

Font Size

Specifies the font size in pixels or percentage (relative to the project's font size).

Attribute Values

Value	Description	Example
<integer>	Font size in pixels.
<percentage>%	Relative font size in percentage.	90%

The default value is: 14.

Font Color

Specifies the text CSS color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

Font Weight

Specifies the weight of the font.

Attribute Values

Value	Description
normal	Default value. Normal.
bold	Bold.
bolder	Bolder.
lighter	Lighter.

The default value is: normal.

Italic

Show the text in italics.

Attribute Values

Value	Description
false	Default value. Normal.
true	Italics.

The default value is: false.

Small Caps

Sets the font to small caps.

Attribute Values

Value	Description
false	Default value. Normal.
true	Small caps.

The default value is: false.

Decoration

Specifies the text decoration.

Attribute Values

Value	Description
none	Default value. No decoration.
underline	Underline.
overline	Overline.
line-through	Line through.

The default value is: none.

Text Align

Sets the horizontal alignment of the text.

Attribute Values

Value	Description
none	Default value. No alignment.
left	Left alignment.
right	Right alignment.
center	Center alignment.
justify	Justified alignment.

The default value is: none.

Line Height

Sets the line height of the text.

Attribute Values

Value	Description
<float>	Specify the line height as a multiple of the font size.

The default value is: 1.0.

CSS Style

note

This attribute has been deprecated since ver. 4.0

View

Visible

Sets the object's visibility.

Attribute Values

Value	Description
true	Default value. Visible.
false	Hidden.

The default value is: true.

Enabled

Specifies if the object is enabled or disabled. A disabled object appears as grayed out and can't be interacted with.

Attribute Values

Value	Description
true	Default value. Enabled.
false	Disabled.

The default value is: true.

Blink

Blinks the object at the specified speed.

Attribute Values

Value	Description
false	Default value. Not blinking.
slow	Blinks slowly.
fast	Blinks fast.

The default value is: false.

Transition

Specifies the transition effect when the object is shown or hidden.

Attribute Values

Value	Description
none	Default value. No transition.
fade	Fade in/out.
fade-left	Slide from left and fade in/out.
fade-right	Slide from right and fade in/out.
fade-up	Slide from top and fade in/out.
fade-down	Slide from bottom and fade in/out.
slide-left	Slide from left.
slide-right	Slide from right.
slide-up	Slide from top.
slide-down	Slide from bottom.
zoom-in	Zoom in.
zoom-out	Zoom out.
3d-flip-left	3D flip from left.
3d-flip-right	3D flip from right.

The default value is: none.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Transition Duration

Specifies the transition duration in milliseconds.

Attribute Values

Value	Description
<integer>	Duration in milliseconds.

This attribute is available when transition is not "none".

When transition is not "none", this attribute defaults to 300.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Transition Delay

Specifies the transition delay in milliseconds.

Attribute Values

Value	Description
<integer>	Delay in milliseconds.

This attribute is available when transition is not "none".

When transition is not "none", this attribute defaults to 0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Opacity

Sets the object's opacity. Opacity is the degree to which content behind an object is hidden.

Attribute Values

Value	Description
0	The object is fully transparent.
>0.0, <1.0	The object is translucent (content behind the element can be seen).
1.0	Default value. The object is fully opaque.

The default value is: 1.0.

Rotation

Specifies the degrees by which the object is rotated. A positive number rotates it clockwise, while a negative value rotates it counter-clockwise.

The default value is: 0.

CSS Class

Specifies a CSS Class that applies to the object, useful to customize its appearance. Custom CSS Classes are specified within the custom.css file.

Margin

Specifies the margin of the object. The margin is the space outside the object's border.

Attribute Values

Value	Description	Example
<int>	Specify the margin in pixels for all sides of the object.
<top> <right> <bottom> <left>	Specify the margin in pixels for each side of the object.	10 20 30 40

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

View Scale

Specifies the scale of the object. The scale is the ratio between the object's size and the size of the view it is contained in.

Attribute Values

Value	Description
<float>	Specify the scale for both width and height of the object.

The default value is: 1.0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Meta

Comment

Specifies a comment, visible only in the Project Editor. It can be used to add a note or a tag to the object. The filter in the object's SELECT panel applies to the comment as well.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Exclude

Excludes the object from the UI. Useful to temporarily hide an object without deleting it. Different from the "Visible" attribute, which hides the object in the UI but keeps it in the project, allowing it to be shown again with a UISet.

Attribute Values

Value	Description
false	Default value. Object is included in the UI.
true	Object is excluded from the UI.

The default value is: false.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.