Form Item

Attributes

Common

Type

Specifies the type of the form item.

Attribute Values

Value	Description
field	Default value. Edit Field.
title	Title.
text	Text.
spacer	Spacer.
inline-button	Inline Button.

The default value is: field.

Data

Data Name

Specifies the data key associated with the item. In datasource mode, this should match the datasource column name. In items mode, this is the keyed value name used by the form's Values attribute. Values starting with _ are treated as custom columns and are not validated against datasource columns. This can be used with custom callbacks.

Attribute Values

Value	Description	Example
<string>	A data key.	address
<string>	A custom callback field name. Values starting with _ are not validated against datasource columns.	_custom

This attribute is available when type is not "selection" and type is not "index" and type is not "inline-button" and type is not "spacer" and action is not "edit" and action is not "delete" and action is not "move".

JSON Value

If true, interprets the source value as a JSON object and uses its text or buttonlabel property as the editable field value.

Attribute Values

Value	Description
false	Default value. Value is not interpreted as JSON.
true	Editable value is extracted from JSON.

This attribute is available when type is "field".

When type is "field", this attribute defaults to false.

Title

Title

Specifies the title text.

Attribute Values

Value	Description
<string>	A title.

This attribute is available when type is "title".

When type is "title", this attribute defaults to [Cell's value].

Description

Specifies the description text displayed below the title.

Attribute Values

Value	Description
<string>	A description.

This attribute is available when type is "title".

Text

Description

Specifies the description text.

Attribute Values

Value	Description
<string>	A description.

This attribute is available when type is "text".

Spacer

Height

Specifies the height of the spacer in pixels.

Minimum value is 1.

This attribute is available when type is "spacer".

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

Divider

Displays a divider centered inside the spacer.

Attribute Values

Value	Description
false	Default value. False.
true	True.

This attribute is available when type is "spacer".

When type is "spacer", this attribute defaults to false.

Divider Type

Specifies the type of the divider.

Attribute Values

Value	Description
line	Default value. Line.
thick	Thick.

This attribute is available when type is "spacer" and divider is "true".

The default value is: line.

Divider Style

Specifies the style of the divider.

Attribute Values

Value	Description
default	Default value. Default.
dark	Dark.
light	Light.

This attribute is available when type is "spacer" and divider is "true".

The default value is: default.

Field

Label

Specifies the field's label.

Attribute Values

Value	Description
<string>	A label.

This attribute is available when type is "field".

When fieldtype is neither "checkbox" nor "switch" or checkboxlabel is empty, this attribute defaults to the fieldname attribute.

Field Type

Specifies the type of the edit field.

Attribute Values

Value	Description
text	Default value. Single line text field.
multiline	Multi line text field.
checkbox	Checkbox.
switch	Switch.
select	Select box.
radiogroup	Radio group field.
date	Date picker.
time	Time picker.
datetime	Date and time picker.
time-interval	Time interval picker.
keypad	Keypad.
hidden	Hidden field, not displayed in the edit popup. Useful for sending data to the server.

This attribute is available when type is "field".

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

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!

This attribute is available when type is "field".

Default behavior:

• When owner's datamode is "datasource", this attribute defaults to the dataname attribute.
• When type is "field", this attribute defaults to the id attribute.

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.

This attribute is available when type is "field" and fieldtype is neither "checkbox", "switch", "radiogroup", nor "hidden".

Field Icon

Specifies the field's icon image.

Attribute Values

Value	Description
<image>	Image path or icon id.

This attribute is available when type is "field" and fieldtype is neither "checkbox", "switch", "radiogroup", nor "hidden".

Field Secondary Icon

Specifies the field's secondary icon.

Attribute Values

Value	Description
<image>	Image path or icon id.

This attribute is available when type is "field" and fieldtype is neither "checkbox", "switch", "radiogroup", nor "hidden".

When type is "field" and fieldtype is neither "checkbox", "switch", "radiogroup", nor "hidden", this attribute defaults to auto.

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.

This attribute is available when type is "field" and fieldtype is neither "checkbox", "switch", "radiogroup", nor "hidden".

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

Prefix

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

Attribute Values

Value	Description
<string>	Prefix text.

This attribute is available when type is "field" and fieldtype is neither "checkbox", "switch", "radiogroup", nor "hidden".

Suffix

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

Attribute Values

Value	Description
<string>	Suffix text.

This attribute is available when type is "field" and fieldtype is neither "checkbox", "switch", "radiogroup", nor "hidden".

Focus Tooltip

Specifies a description tooltip to display when focusing the field.

Attribute Values

Value	Description
<string>	Tooltip text.

This attribute is available when type is "field" and fieldtype is neither "checkbox", "switch", "radiogroup", nor "hidden".

Required

Specifies if the field is required when adding and editing. If true, an empty/null value is considered not valid. When there are non valid fields, the confirm 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
auto	Default value. If the table is connected to a datasource, this attribute is controlled by the datasource's nullable attribute on the specified column. Otherwise it's set to false.
true	A value is required. Where it applies, null values can't be selected.
false	An empty/null value is accepted.

This attribute is available when type is "field" and fieldtype is not "hidden".

The default value is: auto.

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 "field" and fieldtype is one of "date", "time", "time-interval", or "keypad".

Field Options

Checkbox Label

Specifies a label that is displayed next to the field.

Attribute Values

Value	Description
<string>	A label.

This attribute is available when type is "field" and fieldtype is one of "checkbox" or "switch".

Tri State

If true, clicking the checkbox cycles through true, false and indeterminate. The checkbox can display an indeterminate value even when Tri State is false.

Attribute Values

Value	Description
false	Default value. Two states: false, true.
true	Three states: false, true, undeterminate.

This attribute is available when type is "field" and fieldtype is "checkbox".

The default value is: false.

Keypad Label

Specifies a label.

Attribute Values

Value	Description
<string>	Label.

This attribute is available when type is "field" and fieldtype is "keypad".

Min

Specifies the minimum value allowed.

Attribute Values

Value	Description
<string>	Minimum value.

This attribute is available when type is "field" and fieldtype is "keypad".

Max

Specifies the maximum value allowed.

Attribute Values

Value	Description
<string>	Maximum value.

This attribute is available when type is "field" and fieldtype 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 "field" and fieldtype is "keypad".

Decimals

Specifies the number of decimals allowed.

Attribute Values

Value	Description
<int>	Number of decimals.

This attribute is available when type is "field" and fieldtype is "keypad".

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

Password

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

Attribute Values

Value	Description
false	Default value. Typed value is not hidden.
true	Hide the typed value.

This attribute is available when type is "field" and fieldtype is "keypad".

The default value is: false.

Field Data Mode

Specifies the mode of the data.

Attribute Values

Value	Description
items	Default value. Data is set with the UI attribute Items.
list	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 "field" and fieldtype is one of "select" or "radiogroup".

The default value is: items.

Field 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 is "field" and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "datasource".

When type is "field" and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "datasource", this attribute defaults to the datasourceid attribute.

Field Item Data Map

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

This attribute is available when type is "field" and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "datasource".

Field 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 "field" and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "list".

When type is "field" and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "list", this attribute defaults to the list attribute.

Field 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 "field" and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "items".

When type is "field" and (fieldtype is one of "select" or "radiogroup") and fielddatamode is "items", this attribute defaults to the items attribute.

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 "field" and fieldtype is "select".

The default value is: false.

Field 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 "field" and fieldtype is "select".

Field 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 "field" and fieldtype is "select".

The default value is: false.

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 "field" and fieldtype is "select".

When type is "field" and fieldtype is "select", this attribute defaults to auto.

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 "field" and fieldtype is "select".

The default value is: false.

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 "field" and fieldtype is "text".

The default value is: false.

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 "field" and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype is "select" and freeinput is "true"))).

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 "field" and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype 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 "field" and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype 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 "field" and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype 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 "field" and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype 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 "field" and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype 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 "field" and (fieldtype is "text" or fieldtype is "multiline" or ((fieldtype is "select" and freeinput is "true"))).

Field Width

Width of the edit field in pixels.

Minimum value is 0.

This attribute is available when type is "field" and fieldtype is neither "radiogroup" nor "hidden".

Field Height

Height of the edit field in pixels.

This attribute is available when type is "field" and fieldtype is "multiline".

Margin

Specifies the field margin.

Attribute Values

Value	Description	Example
<int>	Margin in pixels for all sides.
<top> <right> <bottom> <left>	Margin for each side in pixels.	0 0 8 0

This attribute is available when type is "field" and fieldtype is not "hidden".

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 "field" and fieldtype is one of "time" or "datetime".

Default behavior:

• When type is "field" and fieldtype is one of "time" or "datetime", this attribute defaults to 1.
• When type is "field" and fieldtype is "time-interval", this attribute defaults to 1.
• When owner's layout is "steps", 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 "field" and fieldtype is one of "time" or "datetime".

When type is "field" and fieldtype is one of "time" or "datetime", this attribute defaults to minute.

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 "field" and fieldtype is "time-interval".

Default behavior:

• When type is "field" and fieldtype is one of "time" or "datetime", this attribute defaults to 1.
• When type is "field" and fieldtype is "time-interval", this attribute defaults to 1.
• When owner's layout is "steps", 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 "field" and fieldtype is "time-interval".

When type is "field" and fieldtype 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 "field" and fieldtype is "time-interval".

When type is "field" and fieldtype 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 "field" and fieldtype is "time-interval".

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

Min Value

Specifies the minimum value of the time interval, in the unit specified by Unit.

Attribute Values

Value	Description	Example
<float>	Minimum value of the interval.	5.5

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

Max Value

Specifies the maximum value of the time interval, in the unit specified by Unit.

Attribute Values

Value	Description	Example
<float>	Maximum value of the interval.	5.5

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

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 "field" and fieldtype 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":"- -"}].

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 "field" and fieldtype is one of "date" or "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 "field" and fieldtype is one of "date" or "datetime", 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 "field" and fieldtype is one of "date" or "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 "field" and fieldtype is one of "date" or "datetime", 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 "field" and fieldtype is "date".

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

Description

Specifies the field's description text, displayed below the field.

Attribute Values

Value	Description
<string>	A description.

This attribute is available when type is "field" and fieldtype is not "hidden".

Inline Button Action

Action

Specifies the action performed when the inline button is clicked.

Attribute Values

Value	Description
link	Changes page, shows a popup or opens a URL.
command	Default value. Sends a command to the server. The command parameter is a JSON object that includes: - action, set to inline-button - field, identifying the associated field - values, containing the current form values - key or keys, when editing datasource records - popup, when used in an edit popup - button, when Button Name is set The command response supports the Command API, including fields updates for the current form or edit popup.
download	Fires a download request. The request calls userCommand with the same JSON parameter as the command action. The callback returns the file path or content to download. See Handling a download request.

This attribute is available when type is "inline-button".

When type is "inline-button", this attribute defaults to command.

Command Name

Specifies the command name sent by the inline button. If empty, it falls back to the form Command Name, then to the form ID.

Attribute Values

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

This attribute is available when type is "inline-button" and action is one of "command" or "download".

When type is "inline-button" and action is one of "command" or "download", this attribute defaults to the owner's commandname attribute.

Parameter

Specifies the command parameter that is sent to the server.

Attribute Values

Value	Description
<string>	A command parameter.

This attribute is available when type is "inline-button" and action is "command".

Button Name

Specifies the optional identifier included in the JSON command parameter's button property. Use it to distinguish inline buttons that share a Command Name.

Command parameter: { "action": "inline-button", "field": "<field>", "key": "<row key>", "values": { "<field>": "<value>", ... }, "button": "<button name>" } For multi-edit, keys replaces key.

Attribute Values

Value	Description
<string>	Button identifier.

This attribute is available when type is "inline-button" and action is one of "command" or "download".

Link

If set, specifies the link.

This attribute is available when type is "inline-button" and action is "link".

Link Target

Specifies where to open the linked URL. Available only for URL links.

Attribute Values

Value	Description
_self	Default value. Opens the linked URL in the same window or tab.
_blank	Opens the linked URL in a new window or tab.
<string>	Opens the linked URL in a named window or tab. Use this to open multiple links in the same window or tab.

This attribute is available when action is link and link is a valid URL or path.

When action is link and link is a valid URL or path, this attribute defaults to _self.

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.

This attribute is available when type is "inline-button" and action is one of "command" or "download".

The default value is: false.

Confirm

Requires a confirmation before performing the action.

Attribute Values

Value	Description
false	Default value. No confirmation, the action is performed right away.
doubleclick	A second click (or touch or enter key) is required to confirm the action.
popup	A popup is displayed to ask for confirmation.

This attribute is available when type is "inline-button" and action is not empty.

The default value is: false.

Confirm Message

The confirmation message to be displayed if the "confirm" attribute is set to "popup".

Attribute Values

Value	Description	Example
<string>	The message to be displayed in the confirm popup.	Are you sure?

This attribute is available when type is "inline-button" and action is not empty.

Inline Button

Button Label

Specifies the button's label.

Attribute Values

Value	Description
<string>	Button's label.

This attribute is available when type is "inline-button".

Button Description

Specifies a description displayed below the label.

Attribute Values

Value	Description
<string>	Button's description.

This attribute is available when type is "inline-button".

Button Icon

Specifies the icon source to display. Its position is set with the "Icon Position" attribute.

The value can be:

• An icon prefixed with icon:
• A relative path to an image file, such as lights/lamp.png, resolved from the standard image folders

Attribute Values

Value	Description	Example
<icon>	Icon prefixed with icon:.	icon:mdi#account-multiple
<image>	Relative path to the image file.	lights/lamp.png

This attribute is available when type is "inline-button".

Button Color

Specifies the button color.

Attribute Values

Value	Description
default	Default value. Default color.
primary	Primary color, used to highlight action buttons.
warning	Warning color, used to highlight warning buttons.
success	Success color, used to highlight success buttons.
error	Error color, used to highlight error buttons.
light	Light color.
dark	Dark color.
red,blue,yellow,green,yellow,purple,orange,green	Palette colors.
custom	Custom color, defined in the "Custom Color" attribute.

This attribute is available when type is "inline-button".

The default value is: default.

Button Look

Specifies the button'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.
glass	Glass look, with a semi-transparent background.

This attribute is available when type is "inline-button".

The default value is: filled.

Button 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.

This attribute is available when type is "inline-button".

The default value is: none.

Button Width

Specifies the inline button width in pixels.

Minimum value is 0.

This attribute is available when type is "inline-button".

When type is "inline-button", this attribute defaults to 40.

Tooltip

Specifies a tooltip to be displayed when hovering over the button.

Attribute Values

Value	Description	Example
<string>	A tooltip.	This is a tooltip

This attribute is available when type is "inline-button".

Layout

Column

Specifies the column index. First column has index 1.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Column index starting from 1.

The default value is: 1.

Column Span

Specifies how many layout columns the item spans.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Column span starting from 1.

The default value is: 1.

Row

Specifies the starting row of the item in the form layout.

Minimum value is 1.

Attribute Values

Value	Description
auto	Default value. Automatic row placement.
<int>	Row index starting from 1.

The default value is: auto.

Row Span

Specifies how many layout rows the item spans.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Row span starting from 1.

The default value is: 1.

Tab

Specifies the tab index in the form. First tab has index 1.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Tab index starting from 1.

This attribute is available when owner's layout is "tabs".

When owner's layout is "tabs", this attribute defaults to 1.

Step

Specifies the step index in the form. First step has index 1.

Minimum value is 1.

Attribute Values

Value	Description
<int>	Step index starting from 1.

This attribute is available when owner's layout is "steps".

Default behavior:

• When type is "field" and fieldtype is one of "time" or "datetime", this attribute defaults to 1.
• When type is "field" and fieldtype is "time-interval", this attribute defaults to 1.
• When owner's layout is "steps", this attribute defaults to 1.

Visible

Specifies whether the form item is shown. Invisible cells retain their space in partly visible rows; fully invisible rows collapse. Invisible fields retain their values, skip validation, and are submitted only if Save Value is true. Visibility can be toggled dynamically with value bindings and form edit-change commands.

Attribute Values

Value	Description
true	Default value. The item is visible.
false	The item is hidden.

The default value is: true.

Behavior

Enabled

Disabled fields skip validation and are submitted only if Save Value is true.

Attribute Values

Value	Description
true	Default value. The field is enabled.
false	The field is disabled.

This attribute is available when type is "field".

Default behavior:

• When type is "field", this attribute defaults to true.
• When type is "inline-button", this attribute defaults to true.

Save Value

Specifies if the value of this field is sent to the server when confirming.

This attribute does not affect the edit-change command.

If set to "auto", the value is sent if the field is visible and enabled.

If set to "changed", the value is sent to the server if it is different from the initial value and the field is visible and enabled. The initial value is the field value assigned when the form is built. Fields with Field Type hidden are always sent unless Save Value is false. This is useful when server-side change triggers or logic should run only for fields that were actually changed.

Attribute Values

Value	Description
auto	Default value. The value is sent to the server if the field is visible and enabled.
true	The value is always sent, including invisible or disabled fields.
false	The value is never sent to the server.
changed	The value is sent to the server if it is different from the initial value and the field is visible and enabled. Fields with Field Type hidden are always sent unless Save Value is false.

This attribute is available when type is "field".

The default value is: auto.

Enabled

If false, the button is disabled.

Attribute Values

Value	Description
true	Default value. The button is enabled.
false	The button is disabled.

This attribute is available when type is "inline-button".

Default behavior:

• When type is "field", this attribute defaults to true.
• When type is "inline-button", this attribute defaults to true.