The <form> tag is a widget displaying a record form when necessary parameters (such as the table, form view, and record ID) are specified. It allows users to interact with the record form, while maintaining the form reaction. It also supports the functionality of widgets added to the form.

Structure

This widget generally has the following structure:

  1. The embedded widget that contains the form elements.
  2. The header block:
    1. A header can be taken from the column with the Display by Ref checkbox selected.
  3. The section block:
    1. The Default section should be the first in the section list if there is more than one.
    2. Every widget section is linked to the corresponding form section and has its own title. 
    3. This block is mandatory.
  4. The footer block that contains UI actions (buttons and others).

Elements 

Form widget elements, like form elements, can be of different types. Functionality of all field types used in forms is supported in the widgets (such as properties, behavior, scalar type, and so on).

  • If a widget element displays date and time, it is displays them in the user timezone.
  • The widget elements containing multilanguage fields and use the Translated Text field type (such as table and column titles, choice options) display the values in the current user locale.

Attributes

To create a dynamic form, use the following attributes:

Attribute

Type

Mandatory

Description

classStringNSpecify a CSS class name defined in the CSS field of the widget.
isPortalBooleanNTo enable the tag to be displayed on the portal, set the value true. The default value is false.
nameStringN

This attribute stores the form name.

Define the form name within the template in the Template field:

<Form tableName="{data.table_name}" sysId="{data.record_id}" name="custom"></Form>

Then call it in the widget client script:

const builtInForm = s_widgets.getForm('custom');
await builtInForm.save();


tableNameStringYSpecify the table name.
viewStringNDefine a view name of the table, for example, Default.
saveStringN

Add a Save button on the form with the customized text (see the code example below).

It makes sense to use this attribute when it is impossible to use the UI actions due to any reasons (the uiActions attribute is equal to false).

titleHideBooleanNIf set to true by default, the form header is hidden.
uiActionsBooleanNSet this attribute value to true to make UI actions available to use. Otherwise, their usage is prohibited (except for the Save button specified by the save attribute).
userScriptsBooleanNTo make client scripts defined in the Client script field available to use, set this attribute value to true. Otherwise, their usage is prohibited.
sysidStringN

Specify the ID of the table record. The table should be specified first via the tableName attribute.

If you do not specify the sysid parameter, a form of a new record will be displayed.


Form example

<Form tableName="user" sysid="158747771611397284" view="Profile" save="Custom save button" uiActions="true" userScripts="true"></Form>