Edit Popup
Describes a configurable edit popup used by editable collection objects.
Each popup mirrors form capabilities so that collection actions can surface tailored fields and validation rules.
Attributes
Popup
ID
Specifies the unique identifier for this popup.
Attribute Values
| Value | Description |
|---|---|
| <string> | Popup ID. |
Popup Width
Specifies the popup's width in pixels. Use "auto" to fit content.
Minimum value is 0.
Attribute Values
| Value | Description |
|---|---|
| <int> | Width in pixels. |
Default behavior:
- When
#ownerObjIdis "table", this attribute defaults to the owner'seditpopupwidthattribute. - Otherwise, this attribute defaults to
300.
Popup Height
Specifies the popup's height in pixels. Use "auto" to fit content.
Minimum value is 0.
Attribute Values
| Value | Description |
|---|---|
| <int> | Height in pixels. |
The default value is: auto.
Field Width
Specifies the popup field width in pixels.
Minimum value is 0.
Attribute Values
| Value | Description |
|---|---|
| <int> | Width in pixels. |
Default behavior:
- When
#ownerObjIdis "table", this attribute defaults to the owner'seditpopupfieldwidthattribute. - Otherwise, this attribute defaults to
auto.
Field Height
Specifies the popup field height in pixels.
Minimum value is 16.
Attribute Values
| Value | Description |
|---|---|
| <int> | Height in pixels. |
Default behavior:
- When
#ownerObjIdis "table", this attribute defaults to the owner'seditpopupfieldheightattribute. - Otherwise, this attribute defaults to
24.
Display Required Fields
Displays a symbol next to required fields' labels in the popup.
Attribute Values
| Value | Description |
|---|---|
| true | Display. |
| false | Default value. Hide. |
Default behavior:
- When
#ownerObjIdis "table", this attribute defaults to the owner'sdisplayrequiredfieldsattribute. - Otherwise, this attribute defaults to
true.
Data
Data Mode
Specifies how the popup's form retrieves its data. Inherit from the table by default.
Use items to work with the field definitions provided by the popup itself, or datasource to bind the form directly to a datasource.
Attribute Values
| Value | Description |
|---|---|
| items | Populate using the popup's Items definition. |
| datasource | Populate by querying a datasource. |
By default, this attribute uses the owner's datamode attribute.
Datasource ID
Specifies which datasource the popup form connects to when it operates in datasource mode.
Attribute Values
| Value | Description |
|---|---|
| [Datasource ID] | Datasource identifier. |
This attribute is available when datamode is "datasource".
When datamode is "datasource", this attribute defaults to the owner's datasourceid attribute.
Form
Items
Specifies the form items used to build the form. Each item can declare fields, titles, spacers and other UI elements.
In items mode, field items also provide the form's data mapping through the Data Name attribute.
Attribute Values
| Value | Description |
|---|---|
| <JSON Array> | Form item definitions. |
Submit Button
Specifies whether to display the submit button.
Fields can also be submitted by an external button with action=submit in the same container/page scope.
During submission, the form fields, navigation controls, reset and cancel buttons are disabled and the submit button displays a loader. The form keeps processing the request if its page or containing popup is hidden, retaining its values and pending state if reopened before completion. A containing popup remains independent and can still be closed unless it is a system-owned editor, such as a table edit popup, that explicitly locks itself during submission.
Attribute Values
| Value | Description |
|---|---|
| true | Default value. The submit button is displayed. |
| false | The submit button is not displayed. |
The default value is: true.
Submit Button Label
Specifies the label displayed on the submit button.
Attribute Values
| Value | Description |
|---|---|
| <string> | Label text. |
This attribute is available when submitbutton is "true".
Footer Items
Specifies optional items displayed before the form's built-in footer controls.
Supported types are button, text, icon, spacer and divider. Footer items support value bindings such as visible-bind, enabled-bind, text-bind, icon-bind and tooltip-bind. Bindings can use dataValue() for the form's bound value and formValue() for the current unsaved field value.
Hidden items don't occupy space. A flexible spacer can separate custom items from the reset, cancel, navigation and submit buttons.
Attribute Values
| Value | Description |
|---|---|
| <JSON Array> | Form footer item definitions. |
This attribute is experimental. It might not work properly and it might be modified or removed in a future release.
Layout
Reset Button
Specifies whether to display the reset button.
Attribute Values
| Value | Description |
|---|---|
| true | The reset button is displayed. |
| false | Default value. The reset button is not displayed. |
The default value is: false.
Data
Multi Edit Mode
Experimental. bulk edits shared values for the selected keys. split repeats the basic form layout for each Data Key in one scrollable area, with a shared footer and no multi-edit checkboxes.
In split items mode, Values is an object keyed by Data Key, containing each record's values. Data Key controls record order, including a single selected key. An empty Data Key keeps the ordinary add form.
Split saves use datasource updates or an edit command with dataByKey, an object keyed by record key. Shared footer commands use valuesByKey. Traditional submit commands and external submit buttons are unsupported.
Edit-change and inline-button commands use the originating record's key and ordinary values. Their fields reply targets that record; fieldsByKey targets explicit records in any split-form command reply.
Datasource patches with different saved columns use separate requests; a save can partially succeed, and retries skip already saved values.
Attribute Values
| Value | Description |
|---|---|
| bulk | Apply shared field values to all selected keys. |
| split | Edit each selected key in a separate layout. |
By default, this attribute uses the owner's multieditmode attribute.
This attribute is experimental. It might not work properly and it might be modified or removed in a future release.
Layout
Layout
Specifies the layout of the form items. Tabs and steps with no visible items are skipped while retaining their field values.
Attribute Values
| Value | Description |
|---|---|
| basic | Default value. All items are displayed in a single column. |
| tabs | Items are grouped into tabs. |
| steps | Items are grouped into steps. |
The default value is: basic.
Tab Labels
Specifies the labels of the tabs, separated by comma.
Attribute Values
| Value | Description | Example |
|---|---|---|
| <string> | Comma-separated list of tab labels. | Tab1,Tab2,Tab3 |
This attribute is available when layout is "tabs".
Step Labels
Specifies the labels of the steps, separated by comma.
Attribute Values
| Value | Description | Example |
|---|---|---|
| <string> | Comma-separated list of step labels. | Step1,Step2,Step3 |
This attribute is available when layout is "steps".
Label Position
Specifies the position of the labels in relation to the edit fields.
Attribute Values
| Value | Description |
|---|---|
| left | Default value. Labels are displayed to the left of the edit fields. |
| top | Labels are displayed above the edit fields. |
| hidden | Labels are not displayed. |
The default value is: left.
Legend
Specifies the legend text displayed at the bottom of the form. By default it displays "* Required" when there are required fields in the form.
Attribute Values
| Value | Description |
|---|---|
| <string> | Legend text. |
This attribute is available when displaylegend is "true".