Class: Form

componyx .UI.Form(id, properties) → {componyx.UI.Form}

Form class.

Constructor

new Form(id, properties) → {componyx.UI.Form}

Parameters:

Name	Type	Description
`id`	String	The id of the component.
`properties`	Object \| HTMLElement	The properties used to initialize the component or the container element.

Mixes In:

componyx.UI.base.methods

Returns:

An instance of the component.

Type: componyx.UI.Form

Extends

componyx.UI.base.WebComponent

Classes

Action
BaseField
BaseSet
BaseType
BuildBlock
Command
ComponentSettings
ContentField
DataSource
Field
FieldOption
FieldRole
FieldSet
FormEvents
Rule
RuleCase
RuleGroup
Section
ServerEndpoint
SpacerField
ValidationSettings

Members

actionComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the action combo-box (inside the Rules configuration panel).

Type:

string

actionEndpoints :Array.<componyx.UI.Form.ServerEndpoint>

Gets or sets the server endpoints used by rule case actions at runtime. Endpoints should return a JSON object with success: true to continue the current rule case actions or success: false to stop the action flow.

Type:

Array.<componyx.UI.Form.ServerEndpoint>

actionTargetComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the action target combo-box (inside the Rules configuration panel).

Type:

string

addActionButtonId :string

Gets or sets the id of the component from which the settings are cloned for the add action button (inside the Rules configuration panel).

Type:

string

addAllowedDatePickerId :string

Gets or sets the id of the component from which the settings are cloned for the date-picker used to add allowed dates (inside the Component configuration panel).

Type:

string

addAllowedItemOptionButtonId :string

Gets or sets the id of the component from which the settings are cloned for the add allowed time/date button (inside the Component configuration panel).

Type:

string

addAllowedTimePickerId :string

Gets or sets the id of the component from which the settings are cloned for the time-picker used to add allowed times (inside the Component configuration panel).

Type:

string

addFieldButtonId :string

Gets or sets the id of the component from which the settings are cloned for the add Field button (inside the Field action-menu).

Type:

string

addFieldOptionButtonId :string

Gets or sets the id of the component from which the settings are cloned for the add Field option button (inside the Field Options configuration panel).

Type:

string

addRuleCaseButtonId :string

Gets or sets the id of the component from which the settings are cloned for the add rule case button (inside the Rules configuration panel).

Type:

string

addRuleGroupButtonId :string

Gets or sets the id of the component from which the settings are cloned for the add rule group button (inside the Rules configuration panel).

Type:

string

alertDialogId :string

Gets or sets the id of the component from which the settings are cloned for the alert dialog action.

Type:

string

autoDataBindFields :boolean

Gets or sets a value indicating if the data binding (via Bindary) is automatically activated on the form fields.

Type:

boolean

autoSaveDelay :number

Gets or sets the delay in milliseconds before saving the form via the configured saveEndpoint (or custom onSave implementation) when in form build mode.

Type:

number

backgroundColorButtonId :string

Gets or sets the id of the component from which the settings are cloned for the background color-button (inside the Content configuration panel).

Type:

string

bindToCustomModel :boolean

Gets or sets a value indicating whether the form binds field values to a custom external model instead of the internal model (form.values).

Type:

boolean

borderColorButtonId :string

Gets or sets the id of the component from which the settings are cloned for the border color-button (inside the Content configuration panel).

Type:

string

borderWidthNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the border width numeric-box (inside the Content configuration panel).

Type:

string

buildBlocks :Array.<componyx.UI.Form.BuildBlock>

Gets or sets the build blocks that are displayed in the form's build pane when the displayMode is set to BUILD.

Type:

Array.<componyx.UI.Form.BuildBlock>

buildPanelBarId :string

Gets or sets the id of the component from which the settings are cloned for the build panel-bar.

Type:

string

buildPanels :Array.<componyx.UI.PanelBar.Panel>|Array.<Object>

Gets or sets the panels of the build panel-bar. If using Panel instances, the PanelBar script must be available at design time. If using plain objects, they are converted at runtime, and the PanelBar script is imported in the preRender phase. The cssClass values of the default panels are used by the built-in styling and should be kept unless you intentionally override the design.

Type:

Array.<componyx.UI.PanelBar.Panel> | Array.<Object>

(constant) classOption :Readonly.<Object.<string, string>>

Internal CSS class name constants. You can override any of these classes on the Component instance by defining a property named cssClass<Key> where is the PascalCase key from this object. Example: 'BUILD_PANE' -> 'cssClassBuildPane' Be cautious: overriding these classes without including the default names may break styling and functionality.

Type:

Readonly.<Object.<string, string>>

cloneFieldButtonId :string

Gets or sets the id of the component from which the settings are cloned for the clone Field button (inside the Field action-menu).

Type:

string

colorPickerId :string

Gets or sets the id of the component from which the settings are cloned for the color picker used by the form component.

Type:

string

commands :Array.<componyx.UI.Form.Command>

Gets or sets the command buttons displayed in the form’s specific placeholder locations.

Type:

Array.<componyx.UI.Form.Command>

compareFieldComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the compare field combo-box (inside the Validation configuration panel).

Type:

string

compareOperatorComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the compare operator combo-box (inside the Validation configuration panel).

Type:

string

comparisonComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the comparison operator combo-box (inside the Rules configuration panel).

Type:

string

configPanelBarId :string

Gets or sets the id of the component from which the settings are cloned for the configuration panel-bar.

Type:

string

configPanels :Array.<componyx.UI.PanelBar.Panel>|Array.<Object>

Gets or sets the panels of the config panel-bar. If using Panel instances, the PanelBar script must be available at design time. If using plain objects, they are converted at runtime, and the PanelBar script is imported in the preRender phase. The cssClass values of the default panels are used by the built-in styling and should be kept unless you intentionally override the design.

Type:

Array.<componyx.UI.PanelBar.Panel> | Array.<Object>

confirmDialogId :string

Gets or sets the id of the component from which the settings are cloned for the confirmation dialog action.

Type:

string

contentFieldEditorId :string

Gets or sets the id of the component from which the settings are cloned for the content field editor (Content Fields in Build Mode).

Type:

string

crsfToken :String

Gets or sets the CRSF Token to send with each server endpoint request.

Type:

String

customModelGetter :function

Gets or sets a method to retrieve the custom external model. When bindToCustomModel is set to true and the form has default field values or form rules this property is required.

Type:

function

dataSourceComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the data source combo-box (inside the Field Options configuration panel).

Type:

string

dataSourcePreviewComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the data source preview combo-box (inside the Field Options configuration panel).

Type:

string

dataSources :Array.<componyx.UI.Form.DataSource>

Gets or sets the data sources available for form fields (server endpoints filtered by input type). Configurable in build mode; used at runtime to populate field options (ComboBox, Checkbox, Radio, Switch) or to upload files.

Type:

Array.<componyx.UI.Form.DataSource>

dataTypeComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the data type combo-box (inside the Validation configuration panel).

Type:

string

displayMode :componyx.UI.Form.DisplayModeOption

Gets or sets a value indicating whether the display is in build, edit or view mode.

Type:

componyx.UI.Form.DisplayModeOption

dragSettings :componyx.library.DraggableSettings

Gets or sets the drag settings for all draggable items.

Type:

componyx.library.DraggableSettings

events :componyx.UI.Form.FormEvents

Type:

componyx.UI.Form.FormEvents

Overrides:

componyx.UI.base.WebComponent#events

fieldAttribute :String

Gets the field attribute name

Type:

String

fieldOptionWidthComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the option width combo-box (inside the Field Options configuration panel).

Type:

string

fieldRoles :Array.<componyx.UI.Form.FieldRole>

Gets or sets the field roles that determine how this field’s data is processed by the backend. Each role can specify a default value and be restricted to certain input types.

Type:

Array.<componyx.UI.Form.FieldRole>

fieldSets :Array.<(componyx.UI.Form.Section|componyx.UI.Form.FieldSet)>

Gets or sets the array of nested field sets. Sections group FieldSets (cannot contain fields) while FieldSets directly contain fields, ensuring every field is always within a FieldSet.

Type:

Array.<(componyx.UI.Form.Section|componyx.UI.Form.FieldSet)>

fieldWidthComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the field width combo-box (inside the Field configuration panel).

Type:

string

fixedLayout :boolean

Gets or sets a value indicating if the form uses a fixed layout with always-visible side panes and header. Useful when embedding the form in full-page layouts.

Type:

boolean

format :componyx.UI.Form.FormatConfig

Gets or sets the format configuration for dates and numbers.

Type:

componyx.UI.Form.FormatConfig

hasDataBindRootContext :boolean

Gets or sets a value indicating whether the form element is configured with a root data binding context (set via the Bindary context attribute). When true, this element serves as the root of the view update, potentially improving performance.

Type:

boolean

includeDisabledFields :String

Gets or sets a value indicating if disabled form fields are included in the form submit.

Type:

String

incrementalValueNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the incremental value numeric-box (inside the Component configuration panel).

Type:

string

insertBuildBlockButtonId :string

Gets or sets the id of the component from which the settings are cloned for the build-block insert button (inside the build panel).

Type:

string

labelDisplay :componyx.UI.FormField.LabelDisplayOption

Gets or sets a value indicating whether the label is displayed automatically, inside, above, before or after the form input field.

Type:

componyx.UI.FormField.LabelDisplayOption

labelDisplayComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the label display combo-box (inside the Field and FieldSet configuration panels).

Type:

string

labels :componyx.UI.Form.LabelSettings

Gets or sets the text labels used by the form.

Type:

componyx.UI.Form.LabelSettings

layoutComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the layout combo-box (inside the FieldSet configuration panel).

Type:

string

logicalOperatorComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the logical operator combo-box (inside the Rules configuration panel).

Type:

string

maxFileSizeNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the max file size numeric-box (inside the Component configuration panel).

Type:

string

maxFilesNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the max files numeric-box (inside the Component configuration panel).

Type:

string

maxHistoryLength :number|null

Gets or sets the maximum items allowed in the history stack. Null means no limit.

Type:

number | null

maxLengthNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the max length numeric-box (inside the Validation configuration panel).

Type:

string

maxRangeNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the max range numeric-box (inside the Validation configuration panel).

Type:

string

maxRepeatsNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the max repeats numeric-box (inside the FieldSet configuration panel).

Type:

string

maxValueDatePickerId :string

Gets or sets the id of the component from which the settings are cloned for the max value date-picker (inside the Component configuration panel).

Type:

string

maxValueNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the max value numeric-box (inside the Component configuration panel).

Type:

string

maxValueTimePickerId :string

Gets or sets the id of the component from which the settings are cloned for the max value time-picker (inside the Component configuration panel).

Type:

string

minLengthNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the min length numeric-box (inside the Validation configuration panel).

Type:

string

minRangeNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the min range numeric-box (inside the Validation configuration panel).

Type:

string

minValueDatePickerId :string

Gets or sets the id of the component from which the settings are cloned for the min value date-picker (inside the Component configuration panel).

Type:

string

minValueNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the min value numeric-box (inside the Component configuration panel).

Type:

string

minValueTimePickerId :string

Gets or sets the id of the component from which the settings are cloned for the min value time-picker (inside the Component configuration panel).

Type:

string

moreSettingsButtonId :string

Gets or sets the id of the component from which the settings are cloned for more settings button (inside the Field configuration panel).

Type:

string

navigatorMenuId :string

Gets or sets the id of the component from which the settings are cloned for the navigator menu used by the form component.

Type:

string

navigatorPanelId :String

Gets or sets the panel id in the build panels for the Navigator. If set to null or if no panel with the specified id exists, the Navigator will not be rendered.

Type:

String

navigatorSearchDelay :number

Gets or sets the delay in milliseconds before applying the navigator search after the user stops typing.

Type:

number

nextButton :componyx.UI.Button

Gets the next button.

Type:

componyx.UI.Button

nextSectionButtonId :string

Gets or sets the id of the component from which the settings are cloned for the next section button.

Type:

string

optionsValueComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the options value combo-box (inside the Rules configuration panel).

Type:

string

precisionNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the precision numeric-box (inside the Component configuration panel).

Type:

string

prevButton :componyx.UI.Button

Gets the previous button.

Type:

componyx.UI.Button

previousSectionButtonId :string

Gets or sets the id of the component from which the settings are cloned for the previous section button.

Type:

string

removeActionButtonId :string

Gets or sets the id of the component from which the settings are cloned for the remove action button (inside the Rules configuration panel).

Type:

string

removeAllowedItemButtonId :string

Gets or sets the id of the component from which the settings are cloned for the remove allowed time/date button (inside the Component configuration panel).

Type:

string

removeFieldButtonId :string

Gets or sets the id of the component from which the settings are cloned for the remove Field button (inside the Field action-menu).

Type:

string

removeFieldOptionButtonId :string

Gets or sets the id of the component from which the settings are cloned for the remove Field Option button (inside the Field Options configuration panel).

Type:

string

removeOptionButtonId :string

Gets or sets the id of the component from which the settings are cloned for the remove option button (inside the Field Options configuration panel).

Type:

string

removeRuleCaseButtonId :string

Gets or sets the id of the component from which the settings are cloned for the remove rule case button (inside the Rules configuration panel).

Type:

string

renderNavigationButtons :boolean

Gets or sets a value indicating whether the form navigation buttons (previous/next/submit) are rendered.

Type:

boolean

runVisibilityComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the run visibility combo-box (inside the Rules configuration panel).

Type:

string

runtimeActions :Object.<string, componyx.UI.Form.ActionConfig>

Gets the registered runtime actions.

Type:

Object.<string, componyx.UI.Form.ActionConfig>

sanitizer :function|null

Gets or sets a custom sanitizer function to sanitize HTML. When set, overrides the built-in sanitizer. The function receives an HTML string and should return a sanitized HTML string. For high-security requirements, consider a dedicated library such as DOMPurify. Client-side sanitization is not a substitute for server-side validation.

Type:

function | null

saveEndpoint :componyx.UI.Form.ServerEndpoint

Gets or sets the endpoint used to save the form definition.

Type:

componyx.UI.Form.ServerEndpoint

sectionSwitchFormFieldId :string

Gets or sets the id of the component from which the settings are cloned for the section switch form-field rendered in the form header.

Type:

string

sectionsValueComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the sections value combo-box displayed for the show_section action (inside the Rules configuration panel).

Type:

string

selectedFieldId :String

Gets the selected field identifier.

Type:

String

selectedFieldSetId :String

Gets the selected field set identifier.

Type:

String

settingUpdateDelay :number

Gets or sets the delay in milliseconds before applying config panel setting changes to the form pane when in form build mode.

Type:

number

sourceFieldComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the source field operator combo-box (inside the Rules configuration panel).

Type:

string

startValueNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the start value numeric-box (inside the Component configuration panel).

Type:

string

submitButton :componyx.UI.Button

Gets the submit button.

Type:

componyx.UI.Button

submitButtonId :string

Gets or sets the id of the component from which the settings are cloned for the submit button.

Type:

string

submitEndpoint :componyx.UI.Form.ServerEndpoint

Gets or sets the endpoint used to submit the form values at runtime.

Type:

componyx.UI.Form.ServerEndpoint

tabIndex :number

Gets or sets the tab index of the form element. A value is required so the form can receive focus programmatically, enabling its keyboard shortcuts.

Type:

number

tickMarksNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the tick marks numeric-box (inside the Component configuration panel).

Type:

string

tooltipManagerId :string

Gets or sets the id of the component from which the settings are cloned for the tooltip manager used by the form component.

Type:

string

triggerComboBoxId :string

Gets or sets the id of the component from which the settings are cloned for the trigger combo-box (inside the Rules configuration panel).

Type:

string

validatorId :string

Gets or sets the id of the component from which the settings are cloned for the validator used by the form component.

Type:

string

valueDatePickerId :string

Gets or sets the id of the component from which the settings are cloned for the value date-picker (inside the Component configuration panel).

Type:

string

valueNumericBoxId :string

Gets or sets the id of the component from which the settings are cloned for the default value numeric-box (inside the Component configuration panel).

Type:

string

valueTimePickerId :string

Gets or sets the id of the component from which the settings are cloned for the value time-picker (inside the Component configuration panel).

Type:

string

values :Object.<string, any>

Gets or sets the current form field values stored by bindingKey or name.

Type:

Object.<string, any>

(static, constant) BlockTypeOption :number

Block Type options

Type:

number

Properties:

Name	Type	Description
`FIELD_SET`	number	A container for grouping related fields.
`FIELD`	number	A standard input field.
`CONTENT_FIELD`	number	A content block for displaying rich text.
`SPACER_FIELD`	number	A spacer field.
`getName`	number

(static, constant) CommandLocationOption :number

Command Location options

Type:

number

Properties:

Name	Type	Description
`HEADER`	number	Commands shown in the top header bar.
`BUILD_PANE_TOP`	number	Commands shown in the top-left corner of the form.
`BUILD_PANE_BOTTOM`	number	Commands shown in the bottom-left corner of the form.
`CONFIG_PANE_TOP`	number	Commands shown in the top-right corner of the form.
`CONFIG_PANE_BOTTOM`	number	Commands shown in the bottom-right corner of the form.

(static, constant) DisplayModeOption :number

Display Type options

Type:

number

Properties:

Name	Type	Description
`EDIT`	number	Editable mode for user input.
`VIEW`	number	View-only mode, for displaying data.
`BUILD`	number	Build mode, for constructing and designing the form.
`PREVIEW`	number	Preview mode. Similar to editable mode but with header.

(static, constant) FieldSetLayoutOption :number

FieldSet Layout options

Type:

number

Properties:

Name	Type	Description
`NONE`	number	No visible layout applied. Fields appear directly in the form.
`DEFAULT`	number	Default fieldset appearance with a thin border and a legend at the top.
`BANNERED`	number	Section with a full-width banner header above the fields, giving it a modern look.

(static, constant) InputTypeOption :number

Input Type options

Type:

number

Properties:

Name	Type	Description
`TEXTBOX`	number	Simple single-line text input.
`TEXTAREA`	number	Multi-line text input.
`CHECKBOX`	number	Checkbox input, for binary options.
`RADIO`	number	Radio button input, for selecting one option from a group.
`SWITCH`	number	Checkbox as switch input, for selecting one option from a group.
`MASKEDTEXTBOX`	number	Textbox input with masking (componyx.UI.MaskedTextBox).
`NUMERICBOX`	number	Input for numeric values (componyx.UI.NumericBox).
`COMBOBOX`	number	Dropdown input (componyx.UI.ComboBox).
`DATEPICKER`	number	Date selector (componyx.UI.DatePicker).
`TIMEPICKER`	number	Time selector (componyx.UI.TimePicker).
`SLIDER`	number	Range slider (componyx.UI.Slider).
`FILEUPLOAD`	number	File upload control (componyx.UI.FileUpload).
`EDITOR`	number	Rich text editor (componyx.UI.Editor).
`getName`	number

(static, constant) RuleCaseRunVisibilityOption :string

Rule Case run options.

Type:

string

Properties:

Name	Type	Description
`VISIBLE`	string	The RuleCase runs only when field is visible.
`HIDDEN`	string	The RuleCase runs when field is hidden.
`SECTION_HIDDEN`	string	The RuleCase runs even when the field's section is hidden.

(static, constant) RuleCaseTriggerOption :string

Rule Case triggers.

Type:

string

Properties:

Name	Type	Description
`ALWAYS`	string	The RuleCase runs both on form initialization and when dependent fields change.
`INIT`	string	The RuleCase runs once when the form initializes.
`CHANGE`	string	The RuleCase runs whenever dependent fields change.
`SHOW_SECTION`	string	The RuleCase runs when the corresponding section becomes visible.
`BEFORE_SUBMIT`	string	The RuleCase runs before the form is being submitted.
`SUBMIT_SUCCEEDED`	string	The RuleCase runs when the form submit was successful.
`SUBMIT_FAILED`	string	The RuleCase runs when the form submit was unsuccessful

(static, constant) RuleComparisonOperatorOption :string

Comparison operators options

Type:

string

Properties:

Name	Type	Description
`EQUAL`	string
`NOT_EQUAL`	string
`GREATER_THAN`	string
`GREATER_THAN_OR_EQUAL`	string
`LESS_THAN`	string
`LESS_THAN_OR_EQUAL`	string
`CONTAINS`	string
`NOT_CONTAINS`	string
`STARTS_WITH`	string
`ENDS_WITH`	string
`EMPTY`	string
`NOT_EMPTY`	string
`VISIBLE`	string
`HIDDEN`	string
`ENABLED`	string
`DISABLED`	string
`REQUIRED`	string
`OPTIONAL`	string

Methods

addField(field, clone) → {componyx.UI.Form.Field}

Adds a new field after the specified field into the fieldSets data.

Parameters:

Name	Type	Default	Description
`field`	componyx.UI.Form.Field		The field after which the new field will be added.
`clone`	boolean	false	A value indicating if the field should be cloned.

Returns:

The added field.

Type: componyx.UI.Form.Field

addFieldSet(fieldSet, clone) → {componyx.UI.Form.FieldSet}

Adds a new field set after the specified field into the fieldSets data.

Parameters:

Name	Type	Description
`fieldSet`	componyx.UI.Form.FieldSet	The field set after which the new field will be added.
`clone`	boolean	A value indicating if the field set should be cloned.

Returns:

The added field set.

Type: componyx.UI.Form.FieldSet

addLineBreak(field)

Adds a line break to the field.

Parameters:

Name	Type	Description
`field`	componyx.UI.Form.Field \| componyx.UI.Form.FieldSet	The field or field set.

addRepeatedFieldSet(fieldSet)

Adds a repeated instance of the given field set, assigning it a new label and tracking it as part of a repeat group.

Parameters:

Name	Type	Description
`fieldSet`	componyx.UI.Form.FieldSet	The original field set to repeat.

addSection(fieldSetsopt) → {componyx.UI.Form.Section}

Adds a new Section as root item into the fieldSets data. Optionally, existing fieldSets can be wrapped inside this new section.

Parameters:

Name	Type	Attributes	Description
`fieldSets`	Array.<Form.FieldSet>	<optional>	Optional array of fieldSets to include in the new Section.

Returns:

The newly added Section.

Type: componyx.UI.Form.Section

canPerformHistoryAction(type) → {boolean}

Checks whether an undo or redo operation is possible based on the current history state.

Parameters:

Name	Type	Description
`type`	string	Either 'undo' or 'redo'.

Returns:

True if the operation is possible; otherwise, false.

Type: boolean

(protected) cloneProperties(properties)

Clones component properties. This method should not be invoked by client code directly but only from inside component code.

Parameters:

Name	Type	Description
`properties`	Object	The properties to clone.

Overrides:

componyx.UI.base.WebComponent#cloneProperties

(async) connectedCallback()

Invoked when the element is added to the DOM. Renders the component if not already in the rendering state.

Overrides:

componyx.UI.base.WebComponent#connectedCallback

deselectField()

Deselects the currently selected field.

deselectFieldSet()

Deselects the currently selected field set.

deselectSection()

Deselects the currently selected section.

destroy(keepEvents, removeElement)

Destroys the component.

Parameters:

Name	Type	Default	Description
`keepEvents`	Boolean		A value indicating if component events should be kept.
`removeElement`	Boolean	true	A value indicating if the corresponding HTML Element should be removed.

Overrides:

componyx.UI.base.WebComponent#destroy

destroyField(field)

Destroys the field.

Parameters:

Name	Type	Description
`field`	componyx.UI.Form.Field	The field to destroy.

destroyFieldSet(fieldSet)

Destroys the field-set.

Parameters:

Name	Type	Description
`fieldSet`	componyx.UI.Form.FieldSet	The field-set to destroy.

destroySection(section)

Destroys the section

Parameters:

Name	Type	Description
`section`	componyx.UI.Form.Section	The section to destroy.

disableSectionMode()

Disables sections mode: flattens all section fieldSets into root.

disconnectedCallback()

Invoked when the element is removed from the DOM. Cleans up the component.

Overrides:

componyx.UI.base.WebComponent#disconnectedCallback

enableSectionMode()

Enables sections mode: wraps all existing root fieldSets into a single Section.

ensureItemId(item, isClone) → {componyx.UI.Form.Field|componyx.UI.Form.FieldSet|componyx.UI.Form.Section}

Ensures that the object has a valid identifier if it is not set.

Parameters:

Name	Type	Default	Description
`item`	componyx.UI.Form.Field \| componyx.UI.Form.FieldSet \| componyx.UI.Form.Section
`isClone`	boolean	false	A value indicating if this field is cloned.

Returns:

The passed object.

Type: componyx.UI.Form.Field | componyx.UI.Form.FieldSet | componyx.UI.Form.Section

(async) executeAction(action, target) → {Promise.<componyx.UI.Form.ActionResult>|void}

Executes a serialized action on a field.

Parameters:

Name	Type	Description
`action`	componyx.UI.Form.Action	The action instance.
`target`	componyx.UI.Form.Field \| componyx.UI.Form.FieldSet	The target field or fieldset on which the action is executed.

Returns:

Returns a promise resolving to an ActionResult or void if no result.

Type: Promise.<componyx.UI.Form.ActionResult> | void

findFieldSetByElement(fieldSets, element) → {Object|null}

Recursively finds a FieldSet by its associated DOM element.

Parameters:

Name	Type	Description
`fieldSets`	Array	The list of FieldSets to search through.
`element`	HTMLElement	The element to find the corresponding FieldSet for.

Returns:

The matching FieldSet, or null if not found.

Type: Object | null

getActiveFieldSet() → {componyx.UI.Form.FieldSet}

Gets the active field set.

Returns:

The active field set.

Type: componyx.UI.Form.FieldSet

getCssClass() → {String}

Gets the css class if it exists and otherwise the default css class.

Overrides:

componyx.UI.base.WebComponent#getCssClass

Returns:

The css class.

Type: String

getEnabledFieldValues() → {Object}

Gets the values of enabled form fields (excludes disabled fields).

Returns:

The form values of all enabled fields.

Type: Object

getField(id, fieldSetopt, fieldsopt) → {componyx.UI.Form.Field|null}

Get field by its identifier.

Parameters:

Name	Type	Attributes	Default	Description
`id`	String			The identifier of the field to retrieve.
`fieldSet`	componyx.UI.Form.FieldSet	<optional>	null	The root field set to start from.
`fields`	Array.<componyx.UI.Form.Field>	<optional>	null	The flattened field collection to speed up the lookup for batched find actions.

Returns:

The field with the specified id, or null if not found.

Type: componyx.UI.Form.Field | null

getFieldByFieldOption(fieldOption) → {componyx.UI.Form.Field}

Retrieves the field by the field option.

Parameters:

Name	Type	Description
`fieldOption`	componyx.UI.Form.FieldOption	The field option.

Returns:

The field to which the field option belongs.

Type: componyx.UI.Form.Field

getFieldContext(field) → {FieldContext|null}

Gets the field context by its identifier in the field sets.

Parameters:

Name	Type	Description
`field`	componyx.UI.Form.Field	The field to find context for.

Returns:

The context of the field.

Type: FieldContext | null

getFieldSet(id, fieldSetsopt) → {componyx.UI.Form.FieldSet|null}

Retrieves a field set by its identifier, searching recursively through all nested field sets.

Parameters:

Name	Type	Attributes	Default	Description
`id`	String			The identifier of the field set to find.
`fieldSets`	Array.<componyx.UI.Form.FieldSet>	<optional>	this.fieldSets	Optional root list of field sets to start from.

Returns:

The field set with the specified id, or null if not found.

Type: componyx.UI.Form.FieldSet | null

getFieldSets(fieldSetopt) → {Array.<Object>}

Retrieves all field sets from the given root or the entire form if none is provided. Searches recursively to include field sets from nested field sets.

Parameters:

Name	Type	Attributes	Default	Description
`fieldSet`	Object	<optional>	null	The root field set to start from.

Returns:

A flat array of all field sets.

Type: Array.<Object>

getFields(fieldSetopt) → {Array.<componyx.UI.Form.Field>}

Retrieves all fields from the given field set or the entire form if none is provided. Searches recursively to include fields from nested field sets.

Parameters:

Name	Type	Attributes	Default	Description
`fieldSet`	componyx.UI.Form.FieldSet	<optional>	null	The root field set to start from.

Returns:

A flat array of all fields.

Type: Array.<componyx.UI.Form.Field>

getParentSection(field) → {componyx.UI.Form.Section}

Retrieves the Section of the current field (if sections are enabled).

Parameters:

Name	Type	Description
`field`	componyx.UI.Form.Field	The field instance.

Returns:

The parent section.

Type: componyx.UI.Form.Section

getSection(id) → {componyx.UI.Form.FieldSet|null}

Retrieves a section by its identifier. Sections are represented as root-level field sets.

Parameters:

Name	Type	Description
`id`	String	The identifier of the section to find.

Returns:

The section with the specified id, or null if not found.

Type: componyx.UI.Form.FieldSet | null

getValidFieldNameFromLabel(label) → {string}

Retrieves the field name from the specified text label.

Parameters:

Name	Type	Description
`label`	string	The text label.

Returns:

A valid field name.

Type: string

guid() → {string}

Gets a unique identifer.

Returns:

A unique identifier.

Type: string

hasSections() → {Boolean}

Checks if the form has any sections (root-level fieldSets of type "Section").

Returns:

True if at least one section exists.

Type: Boolean

init()

Initializes the component with the specified properties.

Overrides:

componyx.UI.base.WebComponent#init

initRules(fieldSets)

Initializes conditional and validation rules. Also updates form navigation button states and moves focus to first form field. Is called automatically after the form is loaded or when a section is shown.

Parameters:

Name	Type	Description
`fieldSets`	Array.<componyx.UI.Form.FieldSet>	The fieldSets for which the rules will be initialized.

insertBuildBlock(buildBlock)

Inserts a build block into the form's active field-set.

Parameters:

Name	Type	Description
`buildBlock`	componyx.UI.Form.BuildBlock	The build block to insert.

isBuildMode() → {boolean}

Gets a value indicating whether the form is in build mode.

Returns:

A value indicating whether the form is in build mode.

Type: boolean

isContentField(type) → {boolean}

Check if the given type is a content-only field.

Parameters:

Name	Type	Description
`type`	string	The type to check.

Returns:

True if the type is a content field.

Type: boolean

isEditMode() → {boolean}

Gets a value indicating whether the form is in edit mode.

Returns:

A value indicating whether the form is in edit mode.

Type: boolean

isField(type) → {boolean}

Check if the given type is a content or input field.

Parameters:

Name	Type	Description
`type`	string	The type to check.

Returns:

True if the type is a content field.

Type: boolean

isFirstSection() → {boolean}

Checks if the currently visible Section is the first one.

Returns:

True if the current Section is the first; otherwise false.

Type: boolean

isGroup(type) → {boolean}

Check if the given type belongs to a group container (e.g., FieldSet, Section).

Parameters:

Name	Type	Description
`type`	string	The type to check.

Returns:

True if the type is a group.

Type: boolean

isInputField(type) → {boolean}

Check if the given type is an input field (user-enterable).

Parameters:

Name	Type	Description
`type`	string	The type to check.

Returns:

True if the type is an input field.

Type: boolean

isLastSection() → {boolean}

Checks if the currently visible Section is the last one.

Returns:

True if the current Section is the last; otherwise false.

Type: boolean

isPreviewMode() → {boolean}

Gets a value indicating whether the form is in preview mode.

Returns:

A value indicating whether the form is in preview mode.

Type: boolean

isViewMode() → {boolean}

Gets a value indicating whether the form is in view mode.

Returns:

A value indicating whether the form is in view mode.

Type: boolean

nextSection()

Shows the next visible Section, if any. Navigates forward within the fieldSets sequence.

previousSection()

Shows the previous visible Section, if any. Navigates backward within the fieldSets sequence.

processChanges()

Processes any pending data changes and updates the form UI accordingly. Call this method after making direct changes to the form data to ensure those changes are rendered and reflected in the UI.

rebindFieldElements(fieldSetopt)

Rebinds label inputs and possible content field values for all fields in the given field set or all fields in the form if none given.

Parameters:

Name	Type	Attributes	Default	Description
`fieldSet`	Object	<optional>	null	The field set containing fields to rebind.

rebindFieldSetLabels(fieldSetopt)

Rebinds legend inputs for all child field sets. If no fieldSet provided, processes all field sets recursively.

Parameters:

Name	Type	Attributes	Default	Description
`fieldSet`	Object	<optional>	null	The parent field set containing child sets.

redo()

Restores the form data to the next state in the redo stack.

registerAction(id, config)

Registers a runtime action.

Parameters:

Name	Type	Description
`id`	string	The unique identifier of the action.
`config`	componyx.UI.Form.ActionConfig	The object to configure the action.

rehydrate(fieldSets)

Converts serialized objects back to their corresponding class instances.

Parameters:

Name	Type	Description
`fieldSets`	Array.<componyx.UI.Form.FieldSet> \| Array.<componyx.UI.Form.Section>	An array of field set objects (FieldSet or Section) to rehydrate.

removeField(field, resetConfigPanelBar)

Removes the specified field from the fieldSets data and adjusts the line break if necessary.

Parameters:

Name	Type	Default	Description
`field`	componyx.UI.Form.Field		The field to be removed.
`resetConfigPanelBar`	Boolean	false	A value indicating if the config panel bar must be reset (disabled and collapsed).

removeFieldSet(fieldSet, resetConfigPanelBar)

Removes the specified field set from the fieldSets data and adjusts the line break if necessary.

Parameters:

Name	Type	Description
`fieldSet`	componyx.UI.Form.FieldSet	The field set to be removed.
`resetConfigPanelBar`	Boolean	A value indicating if the config panel bar must be reset (disabled and collapsed).

removeLineBreak(field, updateProperty)

Removes a line break from the field.

Parameters:

Name	Type	Default	Description
`field`	componyx.UI.Form.Field \| componyx.UI.Form.FieldSet		The field or field set.
`updateProperty`	Boolean	true	A value indicating if the lineBreak property is also updated.

removeRepeatedFieldSet(fieldSet)

Removes a repeated field set instance and updates related UI elements and data.

Adjusts line breaks if necessary.
Removes the associated "remove repeat" button.
Re-enables the "add repeat" button if applicable.

Parameters:

Name	Type	Description
`fieldSet`	componyx.UI.Form.FieldSet	The repeated field set to remove.

removeSection(section)

Removes the specified section from the fieldSets data. Picks a neighbor section (previous if possible, otherwise next) to keep the form visible.

Parameters:

Name	Type	Description
`section`	componyx.UI.Form.Section

(async) render()

Renders the component.

Overrides:

componyx.UI.base.WebComponent#render

renderField(field)

Renders the field.

Parameters:

Name	Type	Description
`field`	componyx.UI.Form.Field	The field to render.

renderFieldSet(fieldSet)

Renders the field-set.

Parameters:

Name	Type	Description
`fieldSet`	componyx.UI.Form.FieldSet	The field-set to render.

renderSection(section)

Renders the section.

Parameters:

Name	Type	Description
`section`	componyx.UI.Form.Section	The section to render.

resetConfigPanelBar()

Resets the config panel bar to default disabled and collapsed state.

(async) save() → {Promise.<Object>}

Saves the current form definition by calling the configured save endpoint. Triggers onSave events and updates the UI save status indicator.

Returns:

Resolves with the save result object.

Type: Promise.<Object>

scheduleSave()

Schedules an auto-save after a delay. Resets the timer if called repeatedly.

selectField(field)

Selects the given field and applies selected styling.

Parameters:

Name	Type	Description
`field`	Object	The field to select.

selectFieldSet(fieldSet)

Selects the given field set and applies selected styling.

Parameters:

Name	Type	Description
`fieldSet`	Object	The field set to select.

selectFirst()

Selects the first field or field set.

selectSection(section, selectFirst)

Selects the given section, making it visible and deselecting the previous one.

Parameters:

Name	Type	Default	Description
`section`	componyx.UI.Form.Section		The section to select.
`selectFirst`	Boolean	false	A value indicating if the first field or fieldSet is selected.

setAction(content)

Sets the Action template. The template supports the below listed interpolations.

{actionSelector}
{remove}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setActiveElement()

Sets the active element for the data observer.

setComponentPanel_ComboBox(content)

Sets the ComponentPanel_ComboBox template. The template supports the below listed interpolations.

{multiSelect}
{multiSelectTagging}
{allowInput}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setComponentPanel_DatePicker(content)

Sets the ComponentPanel_DatePicker template. The template supports the below listed interpolations.

{today}
{value}
{minValue}
{maxValue}
{allowedDates}
{disallowDates}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setComponentPanel_Editor(content)

Sets the ComponentPanel_Editor template. The template supports the below listed interpolations.

{blockStyles}
{links}
{lists}
{images}
{media}
{all}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setComponentPanel_FileUpload(content)

Sets the ComponentPanel_FileUpload template. The template supports the below listed interpolations.

{accept}
{maxFileSize}
{maxFiles}
{dataSourceId}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setComponentPanel_MaskedTextBox(content)

Sets the ComponentPanel_MaskedTextBox template. The template supports the below listed interpolations.

{mask}
{value}
{allowedCharacters}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setComponentPanel_NumericBox(content)

Sets the ComponentPanel_NumericBox template. The template supports the below listed interpolations.

{precision}
{value}
{minValue}
{maxValue}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setComponentPanel_Slider(content)

Sets the ComponentPanel_Slider template. The template supports the below listed interpolations.

{range}
{trackSize}
{startValue}
{value}
{minValue}
{maxValue}
{tickMarks}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setComponentPanel_TimePicker(content)

Sets the ComponentPanel_TimePicker template. The template supports the below listed interpolations.

{value}
{minValue}
{maxValue}
{incrementalValue}
{allowedTimes}
{disallowTimes}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setContentFieldPanel(content)

Sets the ContentFieldPanel template. The template supports the below listed interpolations.

{width}
{margin}
{padding}
{borderWidth}
{borderRadius}
{borderColor}
{backgroundColor}
{lineBreak}
{visible}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setDisplayMode(displayMode)

Sets the display mode and re-renders the component.

Parameters:

Name	Type	Description
`displayMode`	componyx.UI.Form.DisplayModeOption	The display mode in which the form will be rendered.

setFieldOptionsPanel(content)

Sets the FieldOptionsPanel template. The template supports the below listed interpolations.

{optionsType}
{dataSourceId}
{dataSourcePreview}
{inlineOptions}
{optionWidth}
{options}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setFieldPanel(content)

Sets the FieldPanel template. The template supports the below listed interpolations.

{name}
{labelDisplay}
{placeholder}
{tooltip}
{value}
{width}
{required}
{lineBreak}
{visible}
{disabled}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setFieldSetPanel(content)

Sets the FieldSetPanel template. The template supports the below listed interpolations.

{layout}
{labelDisplay}
{repeatable}
{maxRepeats}
{repeatLabel}
{tooltip}
{lineBreak}
{visible}
{disabled}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setHeaderTemplate(content)

Sets the header template. The template supports the below listed interpolations.

{title} This value will be replaced with the form title.
{commands} This value will be replaced with the form commands.

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setLabelDisplay(fieldSet, labelDisplay)

Sets the label display for all fields in the field set.

Parameters:

Name	Type	Description
`fieldSet`	componyx.UI.Form.FieldSet	The field set containing the fields for which to set the label display.
`labelDisplay`	componyx.UI.FormField.LabelDisplayOption	The label display.

setOption(content)

Sets the Option template. The template supports the below listed interpolations.

{name}
{value}
{remove}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setParentReferences(fieldSets, parentopt)

Recursively assign parent references to each field set and its nested field sets.

Parameters:

Name	Type	Attributes	Default	Description
`fieldSets`	Array.<componyx.UI.Form.FieldSet>			Array of field sets or sections.
`parent`	componyx.UI.Form.FieldSet \| null	<optional>	null	Parent field set (null if at root level).

setRule(content)

Sets the Rule template. The template supports the below listed interpolations.

{source}
{operator}
{value}
{connector}
{remove}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setSpacerFieldPanel(content)

Sets the SpacerFieldPanel template. The template supports the below listed interpolations.

{showDivider}
{height}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

setValidationPanel(content)

Sets the ValidationPanel template. The template supports the below listed interpolations.

{required}
{dataType}
{pattern}
{length}
{compare}

Parameters:

Name	Type	Description
`content`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| String	The HTML template.

showSection(section)

Displays the specified Section and updates button and rule states accordingly. Hides the currently visible Section if different.

Parameters:

Name	Type	Description
`section`	componyx.UI.Form.Section	The Section to display.

(async) submit() → {Promise.<void>}

Submits the form values by calling the configured submit endpoint. Executes rule-engine submit triggers and fires submit events.

Returns:

Resolves when submission and related rules have completed.

Type: Promise.<void>

suppressNextChangeEvent(action)

Suppresses any change events fired by the underlying input element during the execution of the provided action. Use this when programmatically setting a component value to prevent the change event from propagating as a user interaction. The suppression is automatically lifted after the action completes, even if it throws.

Parameters:

Name	Type	Description
`action`	function	The action to execute with change events suppressed.

Mixes In:

componyx.UI.base.methods.suppressNextChangeEvent

suppressNextChangeEvent(action)

Suppresses any change events fired by the underlying input element during the execution of the provided action. Use this when programmatically setting a component value to prevent the change event from propagating as a user interaction. The suppression is automatically lifted after the action completes, even if it throws.

Parameters:

Name	Type	Description
`action`	function	The action to execute with change events suppressed.

Mixes In:

componyx.UI.base.methods.suppressNextChangeEvent

togglePane(pane)

Toggles the visibility of a specified side pane (build or config). Adds or removes a CSS class that controls visibility.

Parameters:

Name	Type	Default	Description
`pane`	'build' \| 'config'	build	The pane to toggle ('build' for the left panel, 'config' for the right panel).

toggleSectionMode()

Toggles sections mode.

undo()

Reverts the form data to the previous state in the undo stack.

updateCommandStates()

Updates the visibility and enabled state of UI command buttons based on their associated conditions. Commands are shown/hidden and enabled/disabled according to their isVisible and isEnabled callbacks.

updateField(field)

Updates simple field settings that don't required a re-render.

Parameters:

Name	Type	Description
`field`	componyx.UI.Form.FieldSet	The field to update.

updateFieldOptions(field)

Updates the field with new options for build mode view.

Parameters:

Name	Type	Description
`field`	componyx.UI.Form.FieldSet	The field to update.

updateFieldSet(fieldSet)

Updates simple field set settings that don't required a re-render.

Parameters:

Name	Type	Description
`fieldSet`	componyx.UI.Form.FieldSet	The field-set to update.

updateRemoveButtonState()

Enables or disables remove buttons for root fieldSets, at least one fieldSet is required.

updateSection(section)

Updates simple settings that don't required a re-render.

Parameters:

Name	Type	Description
`section`	componyx.UI.Form.Section	The section to update.

withoutTracking(callback, processChanges)

Executes a block of code without tracking any changes in the undo/redo history stack. Any modifications to form data within the callback will not be recorded in the form's history. This is useful for internal or silent updates that should not be undoable. Optionally, you can disable processing/rendering of the changes by passing false as the second argument.

Parameters:

Name	Type	Default	Description
`callback`	function		The function containing non-history-tracked changes.
`processChanges`	Boolean	true	A value indicating whether to process and render the changes made during the callback.

(static) getCustomType(typeName) → {Object|undefined}

Retrieves the configuration for a registered custom field type.

Parameters:

Name	Type	Description
`typeName`	string	The name of the custom field type.

Returns:

The configuration object for the custom type, or undefined if not registered.

Type: Object | undefined

(static) registerCustomType(typeName, config)

Registers a custom field type.

Parameters:

Name	Type	Description
`typeName`	string	The name of the custom field type.
`config`	componyx.UI.Form.CustomFieldConfig	Configuration for the custom field type.

Type Definitions

ActionConfig

A function that executes an action.

Type:

Object

ActionExecutor(value, target) → {Promise.<componyx.UI.Form.ActionResult>|void}

A function that executes an action.

Parameters:

Name	Type	Description
`value`	any	The value associated with the action.
`target`	componyx.UI.Form.Field \| componyx.UI.Form.FieldSet	The field or fieldset on which the action is executed.

Returns:

Returns a promise resolving to an ActionResult or void if no result.

Type: Promise.<componyx.UI.Form.ActionResult> | void

ActionResult

The result returned by an action execution.

Type:

Object

Properties:

Name	Type	Attributes	Description
`success`	boolean		Indicates if the action succeeded. Returning `success: false` will stop further actions in the Rule Case queue.
`data`	any	<optional>	Optional additional data returned by the action.

BaseEventArgs

// empty additional fields besides form instance

Type:

Object

BaseEventHandler(form, eventArgsopt)

Callback for base form events.

Parameters:

Name	Type	Attributes	Description
`form`	componyx.UI.Form		The form instance firing the event.
`eventArgs`	componyx.UI.Form.BaseEventArgs	<optional>	The event details (optional).

BaseFieldProperties

Type:

Object

Properties:

Name	Type	Attributes	Description
`panelTemplates`	Object.<string, string> \| null	<optional>	Gets or sets the templates to render in each configuration panel. Maps configuration panel ids to template ids.
`parent`	componyx.UI.Form.BaseField \| null	<optional>	The parent field if this set is part of another set.
`id`	string		Gets or sets the id of the field. The id is generated if it's not set.
`name`	string	<optional>	Gets or sets the name of the field.
`width`	string	<optional>	Gets or sets the width of the field.
`cssClass`	string	<optional>	Gets or sets the CSS class of the field.
`cssClassIcon`	string	<optional>	Gets or sets the CSS class of the field icon.
`style`	string	<optional>	Gets or sets the CSS style of the field.
`tooltip`	string	<optional>	Gets or sets the tooltip of the field.
`visible`	boolean	<optional>	Gets a value indicating if the field is visible.
`disabled`	boolean	<optional>	Gets a value indicating if the field is disabled.
`label`	string	<optional>	Gets or sets the label of the field.
`value`	string	<optional>	Gets or sets the value of the option.
`lineBreak`	boolean	<optional>	Gets or sets a value indicating if the field moves to a new line.
`viewTemplate`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| string \| null	<optional>	Gets or sets a custom template to display the field in view mode.
`editTemplate`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| string \| null	<optional>	Gets or sets a custom template to display the field in edit mode.
`element`	HTMLElement \| null	<optional>	Gets the rendered root element.
`lineBreakElement`	HTMLElement	<optional>	Gets the rendered line break element.
`componentSettings`	componyx.UI.Form.ComponentSettings \| null	<optional>	Gets or sets the specific settings configured for the input type component.

BaseSetProperties

Type:

Object

Properties:

Name	Type	Attributes	Description
`headerTemplate`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| string \| null	<optional>	Gets or sets the header template.
`footerTemplate`	HTMLElement \| Array.<HTMLElement> \| DocumentFragment \| string \| null	<optional>	Gets or sets the footer template.
`fieldSets`	Array.<componyx.UI.Form.BaseSet>	<optional>	Gets or sets an array of field sets (nested field groupings).

BuildBlockProperties

Type:

Object

Properties:

Name	Type	Attributes	Default	Description
`panelId`	string	<optional>		Gets or sets the identifier of the panel in which the build block is placed. Item is placed in first Panel if not set.
`blockType`	componyx.UI.Form.BlockTypeOption \| null	<optional>	0	Gets or sets the type of the build block or null if it's a custom field. Defaults to an input field type.
`inputType`	componyx.UI.Form.InputTypeOption \| null	<optional>		Gets or sets the input type of the form field or null if it's a custom field.
`customType`	string	<optional>		Gets or sets the custom type of the form field.
`inputId`	string	<optional>		Gets or sets the id of the edit HTML Element or UI component from which attributes/settings are cloned.
`fieldSet`	componyx.UI.Form.FieldSet	<optional>		Gets or sets the field set of the build block when type is set to FIELDSET.

CSSVariables

Form CSS Variables.

Type:

Object

Properties:

Name	Type	Attributes	Description
`"--fieldset-border-width"`	string	<optional>	Border width of fieldsets.
`"--fieldset-drop-above-margin"`	string	<optional>	34px" - Margin above a drop target fieldset.
`"--fieldset-bannered-drop-above-margin"`	string	<optional>	52px" - Margin above a bannered drop target.
`"--fieldset-nested-margin"`	string	<optional>	Margin for nested fieldsets.
`"--droppable-margin"`	string	<optional>	Margin between droppable zones when dropping a field(set).
`"--droppable-line-size"`	string	<optional>	Height of the droppable line.
`"--build-pane-width"`	string	<optional>	15vw, 260px)" - Width of the build pane.
`"--config-pane-width"`	string	<optional>	25vw, 500px)" - Width of the config pane.
`"--header-height"`	string	<optional>	Height of the header.
`"--fixed-layout-offset-top"`	string	<optional>	Top offset for fixed layout.
`"--fixed-layout-offset-bottom"`	string	<optional>	Bottom offset for fixed layout.
`"--fixed-layout-offset-left"`	string	<optional>	Left offset for fixed layout.
`"--fixed-layout-offset-right"`	string	<optional>	Right offset for fixed layout.
`"--fixed-layout-z-index"`	string	<optional>	Z-index for fixed layout elements.

ComboBoxSettings

Type:

Object

Properties:

Name	Type	Attributes	Description
`multiSelect`	Boolean	<optional>	Gets or sets a value indicating whether multiple items can be selected through checkboxes.
`multiSelectTagging`	Boolean	<optional>	Gets or sets a value indicating whether selected items are displayed as tags.
`allowInput`	Boolean	<optional>	Gets or sets a value indicating whether textual input is allowed.

ComponentSettingsType

Type:

MaskedTextBoxSettings | NumericBoxSettings | ComboBoxSettings | DatePickerSettings | TimePickerSettings | SliderSettings | FileUploadSettings | EditorSettings

ContentFieldProperties

Type:

Object

Properties:

Name	Type	Attributes	Description
`trustHTML`	string	<optional>	Gets or sets a value indicating whether the HTML content of this field is trusted.
`margin`	string	<optional>	Gets or sets the margin of the content field.
`padding`	string	<optional>	Gets or sets the padding of the content field.
`borderWidth`	number \| null	<optional>	Gets or sets the border width of the content field.
`borderRadius`	string	<optional>	Gets or sets the border radius of the content field.
`borderColor`	string	<optional>	Gets or sets the border color of the content field.
`backgroundColor`	string	<optional>	Gets or sets the background color of the content field.

CreateSanitizerEventArgs

Type:

Object

Properties:

Name	Type	Description
`sanitizer`	componyx.base_modules.Sanitizer	The created sanitizer class instance.

CreateSanitizerEventHandler(form, eventArgs)

Callback for sanitizer creation events.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance firing the event.
`eventArgs`	componyx.UI.Form.CreateSanitizerEventArgs	The event details.

CustomFieldConfig

Defines the set of custom field behaviors and configuration.

Type:

Object

Properties:

Name	Type	Attributes	Description
`getter`	componyx.UI.Form.CustomFieldGetter		Function to get the field value.
`setter`	componyx.UI.Form.CustomFieldSetter	<optional>	Function to set the field value.
`renderer`	componyx.UI.Form.CustomFieldRenderer	<optional>	Function to render the field UI.
`updater`	componyx.UI.Form.CustomFieldUpdater	<optional>	Function to update minor properties without full re-render.
`renderValueInput`	componyx.UI.Form.CustomFieldRenderValueInput	<optional>	Function to create the input used in rules/set-value actions.
`configGetter`	componyx.UI.Form.CustomFieldConfigGetter	<optional>	Function returning config fields per panel.
`minorProps`	Set.<string>	<optional>	Set of property names considered minor (trigger partial updates).
`omitProps`	Set.<string>	<optional>	Set of property names to omit from processing changes.

CustomFieldConfigFieldDefinition

Configuration for a field in a configuration panel.

Type:

Object

Properties:

Name	Type	Attributes	Description
`id`	string		Unique identifier/key for the config field (used as HTML id suffix).
`name`	string	<optional>	Name attribute for input elements; defaults to `${namePrefix}${id}`.
`label`	string	<optional>	Label text shown next to the field; auto-fetched from `labels` if missing.
`type`	string	<optional>	Input type: `"input"`, `"textarea"`, `"checkbox"`, or `"radio"`.
`value`	string \| number \| boolean	<optional>	Initial input value (except checkboxes where `checked` is used).
`checked`	boolean	<optional>	Whether a checkbox or radio option is checked.
`options`	Array.<componyx.UI.Form.RadioCheckboxOption>	<optional>	Options for radio/checkbox groups.
`placeholder`	string	<optional>	Placeholder text for input fields.
`config`	Object	<optional>	Additional config such as layout, label display, disabled state, switch style, inline display, tooltip info, etc.
`events`	Object.<string, function()>	<optional>	Event handlers keyed by event names, e.g. `input`, `change`, `blur`.
`fieldElement`	HTMLElement	<optional>	Custom DOM element to use as the field instead of standard input creation.
`disableDataBinding`	boolean	<optional>	If true, disables internal data binding on this field.

Example

{
  id: "required",
  label: "Is Required",
  type: "checkbox",
  value: false,
  config: { switch: true },
  events: { change: onRequiredChange }
}

CustomFieldConfigGetter(form, field, panelName) → {Array.<componyx.UI.Form.CustomFieldConfigFieldDefinition>}

Gets the config fields to render in the field configuration panel.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance.
`field`	componyx.UI.Form.Field	The field instance.
`panelName`	string	The name of the panel in which the config fields are rendered, e.g. 'FieldPanel' or 'ComponentPanel'.

Returns:

Array of config field definitions.

Type: Array.<componyx.UI.Form.CustomFieldConfigFieldDefinition>

CustomFieldGetter(field) → {any}

Gets the value from the field.

Parameters:

Name	Type	Description
`field`	componyx.UI.Form.Field	The field instance.

Returns:

The field value.

Type: any

CustomFieldRenderValueInput(form, field, target, container)

Creates the configurable input value used in rules and set-value actions.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance.
`field`	componyx.UI.Form.Field	The field instance.
`target`	componyx.UI.Form.Rule \| componyx.UI.Form.Action	The target, either a rule or an action.
`container`	HTMLElement	The container element in which to render the output.

CustomFieldRenderer(form, field, element, isView, callback)

Renders the field HTML and must call the callback when rendering is complete.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance.
`field`	componyx.UI.Form.Field	The field instance.
`element`	HTMLElement	The container element to render into.
`isView`	boolean	Indicates if the field is rendered in view mode (not edit mode).
`callback`	function	Callback to invoke when rendering is done.

CustomFieldSetter(field, value)

Sets the value on the field.

Parameters:

Name	Type	Description
`field`	componyx.UI.Form.Field	The field instance.
`value`	any	The value to set.

CustomFieldUpdater(form, field, propName, newValue)

Updates "minor" properties without full re-render. Called when a property in minorProps changes.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance.
`field`	componyx.UI.Form.Field	The field instance.
`propName`	string	The name of the property that changed.
`newValue`	any	The new value of the property.

DatePickerSettings

Type:

Object

Properties:

Name	Type	Attributes	Description
`today`	Boolean	<optional>	Gets or sets a value indicating whether today should be used as initial selected date.
`minValue`	String \| Date	<optional>	Gets or sets the minimum allowed date value.
`maxValue`	String \| Date	<optional>	Gets or sets the maximum allowed date value.
`allowedDates`	Array.<String> \| Array.<Date>	<optional>	Gets or sets a list of allowed calendar dates. Separate two date strings with a space to specify allowed range. When allowed dates are set, date input fields are rendered in readonly mode.
`disallowDates`	Boolean	<optional>	Gets or sets a value indicating if the dates specified in the dates property are disallowed instead of the default allowed.

DropFieldEventArgs

Type:

Object

Properties:

Name	Type	Description
`item`	componyx.UI.Form.Item	The dropped field or fieldSet.

DropFieldEventHandler(form, eventArgs)

Callback for drop field events.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance firing the event.
`eventArgs`	componyx.UI.Form.DropFieldEventArgs	The event details.

EditorSettings

Type:

Object

Properties:

Name	Type	Attributes	Description
`visibleCommands`	componyx.UI.Form.EditorVisibleCommands	<optional>	Gets or sets the editor visible commands settings.

EditorVisibleCommands

Type:

Object

Properties:

Name	Type	Attributes	Description
`all`	Boolean	<optional>	Enables all visible commands.
`block`	Boolean	<optional>	Enables changing block styles.
`link`	Boolean	<optional>	Enables editing links.
`list`	Boolean	<optional>	Enables editing UL/OL lists.
`special`	Boolean	<optional>	Enables special commands (if applicable).

FieldContext

Type:

Object

Properties:

Name	Type	Description
`fieldSet`	componyx.UI.Form.FieldSet	The field set containing the target field.
`fieldSetIndex`	number	The index of the field set in the field set list.
`fieldIndex`	number	The index of the field.
`nextField`	componyx.UI.Form.Field	The rendered field after the target field, or null if it's the last field.
`nextFieldSet`	componyx.UI.Form.FieldSet	The rendered field-set after the target field-set, or null if it's the last field-set.
`isLastField`	boolean	A value indicating if the target field is the last field in the field set.
`isLastFieldSet`	boolean	A value indicating if the target field-set is the last.

FieldEventArgs

Type:

Object

Properties:

Name	Type	Attributes	Description
`field`	componyx.UI.Form.Field		The field instance. Use `field.element` to access the field's root element.
`option`	componyx.UI.Form.FieldOption	<optional>	The optional field option, only available for `onRenderEditFieldOption`.

FieldEventHandler(form, eventArgs)

Callback for field events.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance firing the event.
`eventArgs`	componyx.UI.Form.FieldEventArgs	The event details.

FieldOptionProperties

Type:

Object

Properties:

Name	Type	Attributes	Description
`value`	string	<optional>	Gets or sets the value of the option.
`selected`	boolean	<optional>	Gets or sets a value indicating if the option is selected/checked.
`inputId`	string	<optional>	Gets or sets the id of the HTML Element from which attributes are cloned.
`formFieldId`	string	<optional>	Gets or sets the id of the FormField component from which settings are cloned.

FieldProperties

Type:

Object

Properties:

Name	Type	Attributes	Default	Description
`placeholder`	string	<optional>		Gets or sets the placeholder of the field for when it has no value.
`labelDisplay`	componyx.UI.FormField.LabelDisplayOption	<optional>	3	Gets or sets the label display option of the field (above, before, floating, inside).
`bindingKey`	string	<optional>		Gets or sets the data binding key of the field. Defaults to the field name if not set. Supports dot notation (e.g. "user.address.street"). Only applies when form.bindToCustomModel is true.
`role`	string	<optional>		Gets or sets the role identifier for the field, defining its purpose or behavior.
`autoDataBind`	boolean	<optional>		Gets or sets a value indicating if the data binding (via Bindary) is automatically activated on this form field.
`hideLabel`	boolean	<optional>		Gets or sets a value indicating if the label should be hidden. Ignored in build mode.
`viewAsLabel`	boolean	<optional>		Gets or sets a value indicating if the field value is displayed as a label when in view mode.
`inlineOptions`	boolean	<optional>	true	Gets or sets a value indicating whether options are displayed horizontally or stacked vertically.
`optionWidth`	string	<optional>	auto	Gets or sets the width of a field option (auto, 50%, 33%, 25%, 20%). Only applies when inlineOptions is true.
`options`	componyx.UI.Form.FieldOption	<optional>		Gets or sets the field options for input types CHECKBOX or RADIO.
`inputType`	componyx.UI.Form.InputTypeOption	<optional>		Gets or sets the input type to render the editable field.
`customType`	string	<optional>		Gets or sets the custom type of the form field.
`dataSourceId`	string	<optional>		Gets or sets the id of the data source used for the field.
`dataSourcePreview`	boolean	<optional>		Gets or sets a value indicating if the data source can be previewed in Form Build mode.
`readOnly`	boolean	<optional>		Gets or sets a value indicating if the field is readonly.
`required`	boolean	<optional>		Gets or sets a value indicating if the field is required.
`validationSettings`	ValidationSettings	<optional>		Gets or sets the validation settings of the field.
`ruleCases`	Array.<RuleCase>	<optional>		Gets or sets a list of rule cases.
`inputId`	string	<optional>		Gets or sets the id of the edit HTML Element or UI component from which attributes/settings are cloned.
`viewElementId`	string	<optional>		Gets or sets the id of the view HTML Element from which attributes are cloned.
`formFieldId`	string	<optional>		Gets or sets the id of the FormField component from which settings are cloned.
`viewElement`	HTMLElement	<optional>		Gets the rendered view element.
`editElement`	HTMLElement	<optional>		Gets the rendered edit element.

FieldSetEventArgs

Type:

Object

Properties:

Name	Type	Description
`fieldSet`	componyx.UI.Form.Field	The fieldset instance. Use `fieldSet.element` to access the fieldset's root element.

FieldSetEventHandler(form, eventArgs)

Callback for fieldset events.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance firing the event.
`eventArgs`	componyx.UI.Form.FieldSetEventArgs	The event details.

FieldSetProperties

Type:

Object

Properties:

Name	Type	Attributes	Description
`allowAsRoot`	boolean	<optional>	Gets or sets a value indicating if this field set can be used as a root element in the form.
`layout`	componyx.UI.Form.FieldSetLayoutOption	<optional>	Gets or sets the layout of the field set.
`repeatable`	boolean	<optional>	Gets or sets a value indicating if this field set is repeatable.
`maxRepeats`	number \| null	<optional>	Gets or sets a value indicating how many repeats are allowed for this field set. No value or zero means unlimited.
`repeatLabel`	string	<optional>	Gets or sets the field set repeat label.
`fields`	Array.<componyx.UI.Form.BaseField>	<optional>	Gets or sets the form fields that belong to the field set.

FileUploadSettings

Type:

Object

Properties:

Name	Type	Attributes	Description
`accept`	String	<optional>	Gets or sets the comma-separated list of allowed file extensions (.png, .jpg, .jpeg) or MIME types (image/png or image/*).
`maxFileSize`	Number	<optional>	Gets or sets the max allowed file size in KB.
`maxFiles`	Number	<optional>	Gets or sets the max allowed file count.

FormatConfig

Type:

Object

Properties:

Name	Type	Description
`dateFormat`	string	Gets or sets the input format for dates. Default: MM/dd/yyyy.
`decimalSeparator`	string	Gets or sets the decimal separator for numbers. Default: '.'.
`groupSeparator`	string	Gets or sets the group (thousands) separator for numbers. Default: ','.

HTML_Attributes

A list of internal HTML data-attributes used for identifying form fields.

Type:

Object

Properties:

Name	Type	Description
`data-ui-form-field`	string	Marks an HTMLElement as a Form field; the attribute value is the field's id.

See:

componyx.UI.Form.registerCustomType

Example

// Usage in `connectedCallback()` of a custom element to register a custom field type:
class MyCustomElement extends HTMLElement {
    connectedCallback() {
        const wrapper = this.closest("[data-ui-form-field]");
        if (!wrapper) return;

        const fieldId = wrapper.getAttribute("data-ui-form-field");
        const field = $UI.store['myFormId'].getField(fieldId);
        if (field) {
            // Register the custom field type
            $UI.store.myFormInstance.registerCustomType('MyCustomType', {
                getter: this.getValue.bind(this),
                setter: this.setValue?.bind(this),
                renderer: this.render?.bind(this),
                updater: this.update?.bind(this)
            });
        }
    }
}

LabelSettings

Type:

Object

Properties:

Name	Type	Description
`newItemPrefix`	String	= New - Gets or sets the prefix used when a new type is created without a custom label.
`addItemPrefix`	String	= Add - Gets or sets the prefix used for adding an item. The type description of the item is used as suffix.
`removeItemPrefix`	String	= Remove - Gets or sets the prefix used for removing an item. The type description of the item is used as suffix.
`applyToPrefix`	String	= Apply to - Gets or sets the prefix used for apply to. The type description of the item is used as suffix.
`labelPlaceholder`	String	= Enter a label - Gets or sets the placeholder to display when a label is empty.
`headerTitle`	String	= Form Header - Gets or sets the header title.
`sectionSwitch`	String	= Enable Sections - Gets or sets the label for the Sections switch.
`lineBreak`	String	= Line break - Gets or sets the label for the lineBreak setting in the FieldSet/Field/FieldOption configuration panel.
`visible`	String	= Visible - Gets or sets the label for the visible setting field in the FieldSet/Field configuration panel.
`disabled`	String	= Disabled - Gets or sets the label for the disabled setting in the FieldSet/Field/FieldOption configuration panel.
`readOnly`	String	= Readonly - Gets or sets the label for the readOnly setting in the Field configuration panel.
`selected`	String	= Selected - Gets or sets the label for the selected setting in the FieldOption configuration panel.
`tooltip`	String	= Tooltip - Gets or sets the label for the tooltip setting in the FieldSet/Field configuration panel.
`tooltipHint`	String	= Text shown via info icon - Gets or sets the label for the tooltip setting hint in the FieldSet/Field configuration panel.
`value`	String	= Default Value - Gets or sets the label for the value setting in the Field- and Component- configuration panels.
`minValue`	String	= Minimum Value - Gets or sets the label for the minValue setting in the DatePicker/NumericBox/Slider/TimePicker configuration panel.
`maxValue`	String	= Maximum Value - Gets or sets the label for the maxValue setting in the DatePicker/NumericBox/Slider/TimePicker configuration panel.
`comboBoxDefaultHint`	String	= - Select - - Gets or sets the label for the ComboBox placeholder.
`comboBoxSelectAll`	String	= Select All - Gets or sets the label for the ComboBox placeholder.
`section`	String	= Section - Gets or sets the label used to describe a section.
`fieldSet`	String	= Field Set - Gets or sets the label used to describe a field set.
`fieldSets`	String	= Field Sets - Gets or sets the label used to describe field sets.
`fieldPaneEmptyHint`	String	= Drag a field here... - Gets or sets the message to display when a field pane of a field set is empty.
`fieldSetId`	String	= ID - Gets or sets the label for the id read-only setting field in the FieldSet configuration panel.
`fieldSetLayout`	String	= Layout - Gets or sets the label for the layout setting field in the FieldSet configuration panel.
`fieldSetLayoutNone`	String	= None - Gets or sets the label for the 'None' option of the Layout dropdown in the FieldSet configuration panel.
`fieldSetLayoutDefault`	String	= Default - Gets or sets the label for the 'Default' option of the Layout dropdown in the FieldSet configuration panel.
`fieldSetLayoutBannered`	String	= Bannered - Gets or sets the label for the 'Bannered' option of the Layout dropdown in the FieldSet configuration panel.
`fieldSetLabelDisplay`	String	= Label Display (this group) - Gets or sets the label for the label display setting in the FieldSet configuration panel.
`fieldSetRepeatable`	String	= Repeatable - Gets or sets the label for the repeatable setting field in the FieldSet configuration panel.
`fieldSetMaxRepeats`	String	= Max Repeats - Gets or sets the label for the maximum repeats setting field in the FieldSet configuration panel.
`fieldSetRepeatLabel`	String	= Repeat Label - Gets or sets the label for the repeat label setting field in the FieldSet configuration panel.
`fieldSetRepeatButton`	String	= Add Another - Gets or sets the label for the button to add a repeated field set if the field set does not have a label, otherwise addItemPrefix + label are used.
`field`	String	= Field - Gets or sets the label used to describe a field.
`fields`	String	= Fields - Gets or sets the label used to describe fields.
`fieldName`	String	= Field Name - Gets or sets the label for the name setting in the Field configuration panel.
`fieldPlaceholder`	String	= Placeholder - Gets or sets the label for the placeholder setting in the Field configuration panel.
`fieldPlaceholderHint`	String	= Text shown when empty - Gets or sets the label for the placeholder setting hint in the Field configuration panel.
`fieldWidth`	String	= Width - Gets or sets the label for the width setting in the Field configuration panel.
`fieldWidthHint`	String	= - Select option or type a value - - Gets or sets the label for the width setting hint in the Field configuration panel.
`fieldWidthTooltip`	String	Gets or sets the label for the width setting tooltip in the Field configuration panel.
`fieldWidthAuto`	String	= Auto (360px) - Gets or sets the label for the 'Auto' option of the fieldWidth dropdown in the Field configuration panel.
`fieldWidth1PerRow`	String	= 100% (1 field per row) - Gets or sets the label for the '100%' option of the fieldWidth dropdown in the Field configuration panel.
`fieldWidth2PerRow`	String	= 50% (2 fields per row) - Gets or sets the label for the '50%' option of the fieldWidth dropdown in the Field configuration panel.
`fieldWidth3PerRow`	String	= 33% (3 fields per row) - Gets or sets the label for the '33%' option of the fieldWidth dropdown in the Field configuration panel.
`fieldWidth4PerRow`	String	= 25% (4 fields per row) - Gets or sets the label for the '25%' option of the fieldWidth dropdown in the Field configuration panel.
`fieldRole`	String	= Role - Gets or sets the label for the role setting in the Field configuration panel.
`fieldRoleTooltip`	String	Gets or sets the label for the role setting tooltip in the Field configuration panel.
`fieldLabelDisplay`	String	= Label Display - Gets or sets the label for the label display setting in the Field configuration panel.
`fieldLabelDisplayAbove`	String	= Above - Gets or sets the label for the 'Above' label display option.
`fieldLabelDisplayBefore`	String	= Before - Gets or sets the label for the 'Before' label display option.
`fieldLabelDisplayFloating`	String	= Floating - Gets or sets the label for the 'Floating' label display option.
`fieldLabelDisplayInside`	String	= Inside - Gets or sets the label for the 'Inside' label display option.
`fieldMoreSettings`	String	= More Settings... - Gets or sets the label for the more settings button in the Field configuration panel.
`fieldInlineOptions`	String	= Inline Options - Gets or sets the label for the inline options setting in the Field Options configuration panel.
`fieldOptionWidth`	String	= Option Width - Gets or sets the label for the option width setting in the Field Options configuration panel.
`fieldOptionWidthAuto`	String	= Auto - Gets or sets the label for the 'Auto' option of the optionWidth dropdown in the Field Options configuration panel.
`fieldOptionWidth2PerRow`	String	= 50% (2 items per row) - Gets or sets the label for the '50%' option of the optionWidth dropdown in the Field Options configuration panel.
`fieldOptionWidth3PerRow`	String	= 33% (3 items per row) - Gets or sets the label for the '33%' option of the optionWidth dropdown in the Field Options configuration panel.
`fieldOptionWidth4PerRow`	String	= 25% (4 items per row) - Gets or sets the label for the '25%' option of the optionWidth dropdown in the Field Options configuration panel.
`fieldOption`	String	= Option - Gets or sets the label used to describe a field option.
`fieldOptions`	String	= Options - Gets or sets the label used to describe field options.
`fieldOptionValue`	String	= Option Value - Gets or sets the label used to describe a field option value.
`fieldOptionsType`	String	= Options Type - Gets or sets the label for the options type setting in the Field Option configuration panel.
`fieldOptionsTypeStatic`	String	= Static - Gets or sets the label for the 'Static' options of the option type radio button in the Field Options configuration panel.
`fieldOptionsTypeDataSource`	String	= Data Source - Gets or sets the label for the 'DataSource' options of the option type radio button in the Field Options configuration panel.
`fieldOptionLabelHeader`	String	= Label - Gets or sets the label for the label header of a field-option.
`fieldOptionValueHeader`	String	= Value - Gets or sets the label for the value header of a field-option.
`fieldOptionSelectedHeader`	String	= Selected - Gets or sets the label for the selected header of a field-option.
`fieldOptionDisabledHeader`	String	= Disabled - Gets or sets the label for the disabled header of a field-option.
`dataSourceId`	String	= Data Source ID - Gets or sets the label for the data source id setting in the Field Options configuration panel.
`dataSourcePreview`	String	= Data Source Preview - Gets or sets the label for the data source preview setting in the Field Options configuration panel.
`validationRequired`	String	= Required - Gets or sets the label for the required setting in the Validation configuration panel.
`validationDataType`	String	= Data Type - Gets or sets the label for the dataType setting in the Validation configuration panel.
`validationDataTypeInteger`	String	= Integer - Gets or sets the label for the 'Integer' option of the dataType dropdown in the Validation configuration panel.
`validationDataTypeFloat`	String	= Float - Gets or sets the label for the 'Float' option of the dataType dropdown in the Validation configuration panel.
`validationDataTypeDateTime`	String	= DateTime - Gets or sets the label for the 'DateTime' option of the dataType dropdown in the Validation configuration panel.
`validationDataTypeEmail`	String	= Email - Gets or sets the label for the 'Email' option of the dataType dropdown in the Validation configuration panel.
`validationDataTypeURL`	String	= URL - Gets or sets the label for the 'URL' option of the dataType dropdown in the Validation configuration panel.
`validationDataTypeSource`	String	= Source - Gets or sets the label for the 'Source' option of the DataType dropdown in the Validation configuration panel.
`validationPattern`	String	= Pattern - Gets or sets the label for the pattern setting in the Validation configuration panel.
`validationPatternHint`	String	= Regular expression (e.g. ^[0-9]+$) - Gets or sets the label for the pattern setting hint in the Validation configuration panel.
`validationLength`	String	= Length - Gets or sets the label for the length setting in the Validation configuration panel.
`validationMinLengthHint`	String	= Min Length - Gets or sets the label for the min length setting hint in the Validation configuration panel.
`validationMaxLengthHint`	String	= Max Length - Gets or sets the label for the max length setting hint in the Validation configuration panel.
`validationRange`	String	= Range - Gets or sets the label for the range setting in the Validation configuration panel.
`validationMinRangeHint`	String	= Min Range - Gets or sets the label for the min range setting hint in the Validation configuration panel.
`validationMaxRangeHint`	String	= Max Range - Gets or sets the label for the max range setting hint in the Validation configuration panel.
`validationCompare`	String	= Compare To - Gets or sets the label for the compare setting in the Validation configuration panel.
`validatorMessage_required`	String	= {field} is required. - Gets or sets the label for required field validation error messages.
`validatorMessage_range`	String	= {field} must be between {min} and {max}. - Gets or sets the label for numeric range validation error messages.
`validatorMessage_length`	String	= {field} must be between {min} and {max} characters long. - Gets or sets the label for minimum/maximum length validation error messages.
`validatorMessage_integer`	String	= {field} must be a valid number. - Gets or sets the label for integer data type validation error messages.
`validatorMessage_float`	String	= {field} must be a valid decimal number. - Gets or sets the label for float data type validation error messages.
`validatorMessage_datetime`	String	= {field} must be a valid date. - Gets or sets the label for datetime data type validation error messages.
`validatorMessage_email`	String	= {field} must be a valid email address. - Gets or sets the label for email data type validation error messages.
`validatorMessage_url`	String	= {field} must be a valid URL. - Gets or sets the label for URL data type validation error messages.
`validatorMessage_source`	String	= {field} must be a valid source. - Gets or sets the label for source data type validation error messages.
`validatorMessage_compare`	String	= {field} must be {operator} {compareField}. - Gets or sets the label for comparison validation error messages.
`validatorMessage_pattern`	String	= {field} has an invalid format. - Gets or sets the label for regex/pattern validation error messages.
`ruleCase`	String	= Rule Case - Gets or sets the label used to describe a rule case.
`ruleGroup`	String	= Rule Group - Gets or sets the label used to describe a rule group.
`ruleCaseHeader`	String	= Rule Case - Gets or sets the label for the rule case header in the Rules configuration panel.
`ruleCaseTrigger`	String	= Case Trigger - Gets or sets the label for the rule case trigger setting in the Rules configuration panel.
`ruleCaseRunVisibility`	String	= Run When - Gets or sets the label for the rule case run visibility setting in the Rules configuration panel.
`ruleGroupConnector`	String	= Group Connector - Gets or sets the label for the rule group connector setting in the Rules configuration panel.
`ruleGroupsEmptyHint`	String	= Actions will fire unconditionally - Gets or sets the message to display when the rule groups container element is empty.
`actionsHeader`	String	= Actions - Gets or sets the label for the actions header in the Rules configuration panel.
`ruleFieldHint`	String	= - Field - - Gets or sets the label for the rule field setting hint in the Rules configuration panel.
`ruleComparisonOperatorHint`	String	= - Condition - - Gets or sets the label for the rule comparison operator hint in the Rules configuration panel.
`operator_and`	String	= AND - Gets or sets the label for the AND logical operator.
`operator_or`	String	= OR - Gets or sets the label for the OR logical operator.
`operator_equal`	String	= Equal - Gets or sets the label for the equal operator.
`operator_not_equal`	String	= Not Equal - Gets or sets the label for the not equal operator.
`operator_less_than`	String	= Less Than - Gets or sets the label for the less than operator.
`operator_less_than_or_equal`	String	= Less Than Or Equal - Gets or sets the label for the less than or equal operator.
`operator_greater_than_or_equal`	String	= Greater Than Or Equal - Gets or sets the label for the greater than or equal operator.
`operator_greater_than`	String	= Greater Than - Gets or sets the label for the greater than operator.
`operator_contains`	String	= Contains - Gets or sets the label for the contains operator.
`operator_not_contains`	String	= Does Not Contain - Gets or sets the label for the not contains operator.
`operator_starts_with`	String	= Starts With - Gets or sets the label for the starts with operator.
`operator_ends_with`	String	= Ends With - Gets or sets the label for the ends with operator.
`operator_empty`	String	= Empty - Gets or sets the label for the empty operator.
`operator_not_empty`	String	= Not Empty - Gets or sets the label for the not empty operator.
`operator_visible`	String	= Visible - Gets or sets the label for the visible operator.
`operator_hidden`	String	= Hidden - Gets or sets the label for the hidden (not visible) operator.
`operator_enabled`	String	= Enabled - Gets or sets the label for the enabled operator.
`operator_disabled`	String	= Disabled - Gets or sets the label for the disabled operator.
`operator_required`	String	= Required - Gets or sets the label for the required operator.
`operator_optional`	String	= Optional - Gets or sets the label for the optional operator.
`trigger_always`	String	= Always - Gets or sets the label for the always rule case trigger.
`trigger_change`	String	= On Field Change - Gets or sets the label for the change rule case trigger.
`trigger_init`	String	= On Form Load - Gets or sets the label for the init rule case trigger.
`trigger_show_section`	String	= On Show Section - Gets or sets the label for the show section rule case trigger.
`trigger_before_submit`	String	= Before Form Submit - Gets or sets the label for the before submit rule case trigger.
`trigger_submit_succeeded`	String	= After Successful Submit - Gets or sets the label for the succeeded submit rule case trigger.
`trigger_submit_failed`	String	= After Failed Submit - Gets or sets the label for the failed submit rule case trigger.
`run_visibility_visible`	String	= Field is Visible - Gets or sets the label for the rule case run visibility 'visible' option.
`run_visibility_hidden`	String	= Field is Visible or Hidden - Gets or sets the label for the rule case run visibility 'hidden' option.
`run_visibility_section_hidden`	String	= Section is Hidden - Gets or sets the label for the rule case run visibility 'section_hidden' option.
`action_value`	String	= Set Value - Gets or sets the label for the set field value action.
`action_expression`	String	= Set Value Expression - Gets or sets the label for the set field value expression action.
`action_feedback`	String	= Feedback Message - Gets or sets the label for the set field feedback value action.
`action_alert`	String	= Alert Dialog - Gets or sets the label for the set field alert value action.
`action_confirm`	String	= Confirmation Dialog - Gets or sets the label for the set field confirm value action.
`action_required`	String	= Set Required - Gets or sets the label for the set field required action.
`action_optional`	String	= Set Optional - Gets or sets the label for the set field optional action.
`action_hide`	String	= Hide - Gets or sets the label for the hide field action.
`action_show`	String	= Show - Gets or sets the label for the show field action.
`action_disable`	String	= Enable - Gets or sets the label for the disable field action.
`action_enable`	String	= Disable - Gets or sets the label for the enable field action.
`action_read`	String	= Read only - Gets or sets the label for the readonly field action.
`action_editable`	String	= Editable - Gets or sets the label for the editable field action.
`action_disable_next`	String	= Disable Next/Submit - Gets or sets the label for the disable next/submit button action.
`action_enable_next`	String	= Enable Next/Submit - Gets or sets the label for the disable next/submit button action.
`action_cancel`	String	= Cancel Submit - Gets or sets the label for the cancel submit action.
`action_show_section`	String	= Show Section - Gets or sets the label for the show section action.
`action_end`	String	= End Form - Gets or sets the label for the end form action.
`actionValueHint`	String	= Enter a Value - Gets or sets the label for the 'Set Value' action hint in the Rules configuration panel.
`actionExpressionHint`	String	= Enter an Expression - Gets or sets the label for the 'Set Expression' action in the Rules configuration panel.
`componentPanelHeader`	String	= {0} Configuration - Gets or sets the label for the component configuration panel header. The {0} tag gets replaced with the name of the component.
`textbox`	String	= Textbox - Gets or sets the label for the friendly name when the field input type is a textbox element.
`textarea`	String	= Textarea - Gets or sets the label for the friendly name when the field input type is a textarea element.
`checkbox`	String	= Checkbox - Gets or sets the label for the friendly name when the field input type is a checkbox element.
`radio`	String	= Radio - Gets or sets the label for the friendly name when the field input type is a radio element.
`switch`	String	= Switch - Gets or sets the label for the friendly name when the field input type is a switch element.
`maskedTextBox`	String	= Masked Textbox - Gets or sets the label for the friendly name when the field input type is a MaskedTextBox component.
`numericBox`	String	= Number - Gets or sets the label for the friendly name when the field input type is a NumericBox component.
`comboBox`	String	= Dropdown - Gets or sets the label for the friendly name when the field input type is a ComboBox component.
`datePicker`	String	= Date - Gets or sets the label for the friendly name when the field input type is a DatePicker component.
`timePicker`	String	= Time - Gets or sets the label for the friendly name when the field input type is a TimePicker component.
`slider`	String	= Slider - Gets or sets the label for the friendly name when the field input type is a Slider component.
`fileUpload`	String	= File Upload - Gets or sets the label for the friendly name when the field input type is a FileUpload component.
`editor`	String	= Editor - Gets or sets the label for the friendly name when the field input type is a Editor component.
`contentField`	String	= Content - Gets or sets the label for the friendly name when the field type is a Content field.
`spacerField`	String	= Spacer - Gets or sets the label for the friendly name when the field type is a Spacer field.
`multiSelect`	String	= Enable Multi-Selection - Gets or sets the label for the multiSelect setting in the ComboBox configuration panel.
`multiSelectTagging`	String	= Selections as Tags - Gets or sets the label for the multiSelectTagging setting in the ComboBox configuration panel.
`allowInput`	String	= Allow Typing - Gets or sets the label for the allowInput setting in the ComboBox configuration panel.
`today`	String	= Default to Today - Gets or sets the label for the today setting in the DatePicker configuration panel.
`allowedDates`	String	= Allow Listed Dates - Gets or sets the label for the allowedDates setting in the DatePicker configuration panel.
`disallowDates`	String	= Disallow Listed Dates - Gets or sets the label for the disallowDates setting in the DatePicker configuration panel.
`precision`	String	= Decimal Precision - Gets or sets the label for the precision setting in the NumericBox configuration panel.
`mask`	String	= Mask - Gets or sets the label for the mask setting in the MaskedTextBox configuration panel.
`maskTooltip`	String	Gets or sets the label for the tooltip for the mask setting in the MaskedTextBox configuration panel.
`allowedCharacters`	String	= Allowed Characters - Gets or sets the label for the allowedCharacters setting in the MaskedTextBox configuration panel.
`allowedCharactersAlphanumeric`	String	= Alphanumeric - Gets or sets the label for the 'Alphanumeric' option of the allowedCharacters dropdown in the MaskedTextBox configuration panel.
`allowedCharactersDigits`	String	= Digits - Gets or sets the label for the 'Digits' option of the allowedCharacters dropdown in the MaskedTextBox configuration panel.
`allowedCharactersLetters`	String	= Letters - Gets or sets the label for the 'Letters' option of the allowedCharacters dropdown in the MaskedTextBox configuration panel.
`range`	String	= Enable Range Selection - Gets or sets the label for the range setting in the Slider configuration panel.
`trackSize`	String	= Track Size - Gets or sets the label for the trackSize setting in the Slider configuration panel.
`trackSizeHint`	String	= 200px, 100%, 20ch — use CSS units - Gets or sets the label for the trackSize setting hint in the Field configuration panel.
`startValue`	String	= Start Value - Gets or sets the label for the startValue setting in the Slider configuration panel.
`tickMarks`	String	= Tick Marks - Gets or sets the label for the tickMarks setting in the Slider configuration panel.
`incrementalValue`	String	= Step Interval (minutes) - Gets or sets the label for the incrementalValue setting in the TimePicker configuration panel.
`allowedTimes`	String	= Allowed Times - Gets or sets the label for the allowedTimes setting in the TimePicker configuration panel.
`disallowTimes`	String	= Disallow Listed Times - Gets or sets the label for the disallowTimes setting in the TimePicker configuration panel.
`accept`	String	= Accept - Gets or sets the label for the accept setting in the FileUpload configuration panel.
`acceptHint`	String	= .png, .jpg, .jpeg - Gets or sets the label for the placeholder setting hint for the accept setting in the FileUpload configuration panel.
`maxFileSize`	String	= Max. File Size (KB) - Gets or sets the label for the maxFileSize setting in the FileUpload configuration panel.
`maxFiles`	String	= Max. Files - Gets or sets the label for the maxFiles setting in the FileUpload configuration panel.
`all`	String	= All Options - Gets or sets the label for the all setting in the Editor configuration panel.
`block`	String	= Block styles - Gets or sets the label for the block setting in the Editor configuration panel.
`link`	String	= Links - Gets or sets the label for the link setting in the Editor configuration panel.
`list`	String	= Lists - Gets or sets the label for the list setting in the Editor configuration panel.
`special`	String	= Special Chars - Gets or sets the label for the special setting in the Editor configuration panel.
`margin`	String	= Margin - Gets or sets the label for the margin setting in the Content configuration panel.
`marginHint`	String	= 5px, 100% - use CSS units - Gets or sets the label for the margin setting hint in the Content configuration panel.
`padding`	String	= Padding - Gets or sets the label for the padding setting in the Content configuration panel.
`paddingHint`	String	= 5px, 100% - use CSS units - Gets or sets the label for the padding setting hint in the Content configuration panel.
`backgroundColor`	String	= Background color - Gets or sets the label for the backgroundColor setting in the Content configuration panel.
`borderWidth`	String	= Border width - Gets or sets the label for the borderWidth setting in the Content configuration panel.
`borderColor`	String	= Border color - Gets or sets the label for the borderColor setting in the Content configuration panel.
`borderRadius`	String	= Border radius - Gets or sets the label for the borderRadius setting in the Content configuration panel.
`borderRadiusHint`	String	= 5px, 100% - use CSS units - Gets or sets the label for the borderRadius setting hint in the Content configuration panel.
`showDivider`	String	= Show Divider - Gets or sets the label for the showDivider setting in the Spacer configuration panel.
`height`	String	= Height - Gets or sets the label for the height setting in the Spacer configuration panel.
`heightHint`	String	= 10px, 2em - use CSS units - Gets or sets the label for the height setting hint in the Spacer configuration panel.
`saveInProgress`	String	= Saving... - Gets or sets the label for the save-status when the save is in progress.
`saveSuccess`	String	= Saved... - Gets or sets the label for the save-status when the save is successful.
`saveFailed`	String	= Save failed - Gets or sets the label for the save-status when the save failed.
`alertDialogHeader`	String	= Alert - Gets or sets the header label for the alert dialog.
`confirmDialogHeader`	String	= Confirmation - Gets or sets the header label for the confirmation dialog.
`previous`	String	= Previous - Gets or sets the label for the previous section button.
`next`	String	= Next - Gets or sets the label for the next section button.
`submit`	String	= Submit - Gets or sets the label for the submit button.
`navigatorSearchHint`	String	= Find Field - Gets or sets the label for the navigator search-box hint in the Navigator panel.
`buildPanel_fields`	String	= Fields - Gets or sets the label for the title of the Fields build-panel.
`buildPanel_content`	String	= Content - Gets or sets the label for the title of the Content build-panel.
`buildPanel_navigator`	String	= Navigator - Gets or sets the label for the title of the Navigator build-panel.
`configPanel_fieldset`	String	= FieldSet Configuration - Gets or sets the label for the title of the FieldSet config-panel.
`configPanel_field`	String	= Field Configuration - Gets or sets the label for the title of the Field config-panel.
`configPanel_content`	String	= Content Field Configuration - Gets or sets the label for the title of the Content config-panel.
`configPanel_spacer`	String	= Spacer Field Configuration - Gets or sets the label for the title of the Spacer config-panel.
`configPanel_fieldOptions`	String	= Field Options - Gets or sets the label for the title of the Field Options config-panel.
`configPanel_validation`	String	= Validation Rules - Gets or sets the label for the title of the Validation Rules config-panel.
`configPanel_rules`	String	= Conditional Rules - Gets or sets the label for the title of the Conditional Rules config-panel.

MaskedTextBoxSettings

Type:

Object

Properties:

Name	Type	Attributes	Description
`mask`	string	<optional>	Gets or sets the text box mask pattern.
`allowedCharacters`	MaskedTextBox.CharacterAllowOption	<optional>	Gets or sets a value indicating which characters are allowed.

NumericBoxSettings

Type:

Object

Properties:

Name	Type	Attributes	Description
`minValue`	Number	<optional>	Gets or sets the minimium allowed value.
`maxValue`	Number	<optional>	Gets or sets the maximum allowed value.
`precision`	Number	<optional>	Gets or sets the amount of decimal places.

RadioCheckboxOption

Type:

Object

Properties:

Name	Type	Attributes
`value`	string
`label`	string	<optional>
`checked`	boolean	<optional>
`events`	Object	<optional>

SaveEventArgs

Type:

Object

Properties:

Name Type Description

result

Object

The save result. Custom onSave handler(s) must set result.error and result.success ONLY if the onSaveEndpoint is not configured. If the default endpoint is used, these flags are set automatically and handlers can safely ignore them.

Properties

Name	Type	Attributes	Description
`error`	boolean	<optional>	A value indicating if an exception was thrown.
`success`	boolean	<optional>	A value indicating if the completed action returned true (success) or false.

SaveEventHandler(form, eventArgs)

Callback for form save events.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance firing the event.
`eventArgs`	componyx.UI.Form.SaveEventArgs	The event details.

SelectFieldEventArgs

Type:

Object

Properties:

Name	Type	Description
`field`	componyx.UI.Form.Field	The selected field.

SelectFieldEventHandler(form, eventArgs)

Callback for select field events.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance firing the event.
`eventArgs`	componyx.UI.Form.SelectFieldEventArgs	The event details.

SelectFieldSetEventArgs

Type:

Object

Properties:

Name	Type	Description
`fieldSet`	componyx.UI.Form.FieldSet	The selected fieldSet.

SelectFieldSetEventHandler(form, eventArgs)

Callback for select fieldset events.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance firing the event.
`eventArgs`	componyx.UI.Form.SelectFieldSetEventArgs	The event details.

SliderSettings

Type:

Object

Properties:

Name	Type	Attributes	Default	Description
`range`	Boolean	<optional>	false	Gets or sets a value indicating if the slider has a start- and end-handle to set a range.
`startValue`	Number	<optional>	0	Gets or sets the start value of the range slider.
`minValue`	Number	<optional>	0	Gets or sets the minimum value.
`maxValue`	Number	<optional>	100	Gets or sets the maximum value.
`tickMarks`	Number	<optional>		Gets or sets the amount of rendered tickmarks.
`trackSize`	Number	<optional>		Gets or sets the size of the slider track.

SpacerFieldProperties

Type:

Object

Properties:

Name	Type	Attributes	Description
`showDivider`	string	<optional>	Gets or sets a value indicating whether the divider line is rendered in the middle of the spacer.
`height`	string	<optional>	Gets or sets the height of the spacer field.

SubmitEventArgs

Type:

Object

Properties:

Name Type Description

values

Object

The submitted form values.

result

Object

The submit result. Custom onSubmit handler(s) must set result.error and result.success ONLY if the onSubmitEndpoint is not configured. If the default endpoint is used, these flags are set automatically and handlers can safely ignore them.

Properties

Name	Type	Attributes	Description
`error`	boolean	<optional>	A value indicating if an exception was thrown.
`success`	boolean	<optional>	A value indicating if the completed action returned true (success) or false.

SubmitEventHandler(form, eventArgs)

Callback for form submit events.

Parameters:

Name	Type	Description
`form`	componyx.UI.Form	The form instance firing the event.
`eventArgs`	componyx.UI.Form.SubmitEventArgs	The event details.

TimePickerSettings

Type:

Object

Properties:

Name	Type	Attributes	Description
`minValue`	String	<optional>	Gets or sets the minimum allowed time in format 'HH:MM'. Minutes must be divisible by 5.
`maxValue`	String	<optional>	Gets or sets the maximum allowed time in format 'HH:MM'. Minutes must be divisible by 5.
`incrementalValue`	String	<optional>	Gets or sets the incremental value in minutes. Minutes must be divisible by 5.
`allowedTimes`	Array.<String>	<optional>	Gets or sets a list of allowed clock times (format 'HH:MM'). Separate two date strings with a space to specify allowed range. When allowed times are set, date input fields are rendered in readonly mode.Gets or sets a list of allowed calendar dates.
`disallowTimes`	Boolean	<optional>	Gets or sets a value indicating if the times specified in the times property are disallowed instead of the default allowed.