form

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 includes the following elements:

The embedded widget that contains the form elements.
The header block:
1. A header can be taken from the column with the Display by ref checkbox selected.
The section block:

- The Default section should be the first in the section list if there is more than one.
- Every widget section is linked to the corresponding form section and has its own title.
- This block is mandatory.
- 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
class	String	N	Specify a CSS class name defined in the CSS field of the widget.
isPortal	Boolean	N	Set the value to true to enable the tag to be displayed on the portal. The default value is false.
name	String	N	This attribute stores the form name. Define the form name within the template in the Template field: Template example <Form tableName="{data.table_name}" sysId="{data.record_id}" name="custom"></Form> Then call it in the widget client script: Client script example const builtInForm = s_widgets.getForm('custom'); await builtInForm.save();
tableName	String	Y	Specify the table name.
view	String	N	Define a view name of the table, for example, Default.
save	String	N	Add a Save button on the form with the customized text (see the code example below). Use this attribute when it is impossible to use the UI actions due to any reasons (the uiActions attribute is set to false).
titleHide	Boolean	N	Set the value to true to hide the form header by default.
uiActions	Boolean	N	Set the 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).
userScripts	Boolean	N	Set the value to true to make client scripts defined in the Client script field usable.
sysid	String	N	Specify the ID of the table record. The table should be specified first via the tableName attribute. If the sysid attribute is not set, a form of a new record form is displayed.

Form example

Form example

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

Child tag IndicatePresence

Use the <IndicatePresence> tag with the <Form> tag to add the presence indication widget to a form.

To display the widget, the Indicate presence checkbox must be selected on the table form (the indicate_presence attribute is true).

Available attributes:

Атрибут	Тип	Обязательный	Описание
tableName	String	Yes	Specify the table name. This value must be the same as the value of the tableName attribute of the <Form> tag.
recordId	String	Yes	Specify the ID of the record. This value must be the same as the value of the sysid attribute of the <Form> tag.

Example:

IndicatePresence

<IndicatePresence tableName="{data.table_name}" recordId="{data.record_id}"></IndicatePresence>

Page tree