Forms Configuration

The various configuration options for the Forms module are presented and described below.

General Module Configuration

You can access the settings via the administration area under the Forms > General.

Renderer

Settings that affect the render of the Forms module

See Renderer

Name (ID) Description

Name (`ID`)	Description
Renderer URL (`rendererUrl`)	Forms Renderer URL.
Renderer Style (`rendererStyle`)	Style applied to all forms rendered by the Forms Renderer.

Renderer URL
(rendererUrl)

Forms Renderer URL.

Renderer Style
(rendererStyle)

Style applied to all forms rendered by the Forms Renderer.

Module

General module settings

Name (ID) Description

Name (`ID`)	Description
Icon (`module_iconCls`)	Individually selectable icon that is displayed before the title. If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Icon
(module_iconCls)

Individually selectable icon that is displayed before the title.
If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Style Example

To override the renderer style, you can set the variables yourself. The style object must conform to the predefined schema; see Styles.

The following example prevents the default passing of styles by overriding the object of the variables that are passed by default. CSS can also be set according to the style object.

Example:

{
  "variables": {}
}

Component Configuration

You can access the configuration options via the administration area under the Forms > Components.

Module

General module settings

Name (ID) Description

Name (`ID`)	Description
Name (`module_name`)	Name or title of the module/component.
Icon (`module_iconCls`)	Individually selectable icon that is displayed before the title. If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.
Form ID (`formId`)	ID of a form in the Forms Repository. Only set if the configuration of the form to be displayed is to be loaded from the Forms Repository. Not to be used in conjunction with Form URL or embedded form configuration. See Forms Repository
Form Version (`formVersion`)	Version number of the form to be used. Is only used in conjunction with Form ID to load the corresponding version of the form from the repository. If the value <code>-1</code> is set, the latest version is always used.
Form URL (`formUrl`)	This URL is used to load the form configuration to be used. Not to be used in conjunction with Form ID or Create new scratch file from selection.
Display in debug mode (`debug`)	If active, the form is displayed in debug mode. Additional information is offered in this display. This is intended to support the configuration of the form.
Embedded form configuration (`embeddedForm`)	Form configuration stored directly in this component. Not to be used in conjunction with Form URL or Form ID.

Name
(module_name)

Name or title of the module/component.

Icon
(module_iconCls)

Individually selectable icon that is displayed before the title.
If no icon is to be displayed, e.g. "none" can be entered. If the field is empty, a standard icon is selected.

Form ID
(formId)

ID of a form in the Forms Repository.
Only set if the configuration of the form to be displayed is to be loaded from the Forms Repository.
Not to be used in conjunction with Form URL or embedded form configuration.

See Forms Repository

Form Version
(formVersion)

Version number of the form to be used. Is only used in conjunction with Form ID to load the corresponding version of the form from the repository.
If the value <code>-1</code> is set, the latest version is always used.

Form URL
(formUrl)

This URL is used to load the form configuration to be used.
Not to be used in conjunction with Form ID or Create new scratch file from selection.

Display in debug mode
(debug)

If active, the form is displayed in debug mode. Additional information is offered in this display. This is intended to support the configuration of the form.

Embedded form configuration
(embeddedForm)

Form configuration stored directly in this component.
Not to be used in conjunction with Form URL or Form ID.

Keywords: