Constructor
new Field(propertiesopt)
Parameters:
| Name |
Type |
Attributes |
Description |
properties |
BaseFieldProperties
|
FieldProperties
|
<optional>
|
The properties used to initialize the object. |
Extends
Members
autoDataBind :boolean|null
Gets or sets a value indicating if the data binding (via Bindary) is automatically activated on this form field.
Type:
bindingKey :string
Gets or sets the data binding key of the field. If not provided, the field name is used as the key.
Type:
customType :string|null
Gets or sets the custom type of the form field.
Type:
dataSourceId :string|null
Gets or sets the id of the data source used for the field.
Type:
dataSourcePreview :boolean
Gets or sets a value indicating if the data source can be previewed in the Form Build mode.
Type:
editElement :HTMLElement|null
Gets the rendered edit element.
Type:
Gets or sets the id of the FormField component from which the settings are cloned.
Type:
hideLabel :boolean|null
Gets or sets a value indicating if the label should be hidden. Setting is ignored in build mode.
Type:
inlineOptions :boolean
Gets or sets a value indicating whether options are displayed horizontally or stacked vertically.
Type:
Gets or sets the id of the edit HTML Element (TextBox, TextArea) or UI component from which the attributes/settings are cloned.
Type:
Gets or sets the input type to render the editable field.
Type:
Gets or sets the label display option of the field (above, before, floating, inside).
Type:
optionWidth :string
Gets or sets the width of a field option (auto - sized by content; 50% - 2 per row; 33% - 3 per row; 25% - 4 per row; 20% - 5 per row).
Type:
Gets or sets the field options for when the input type is set to CHECKBOX or RADIO.
Type:
placeholder :string
Gets or sets the placeholder of the field for when it has no value.
Type:
readOnly :boolean
Gets a value indicating if the field is readonly.
Type:
renderedEditComponent :componyx.UI.Base.Component|componyx.UI.Base.WebComponent|HTMLElement
Gets the rendered edit component.
Type:
-
componyx.UI.Base.Component
|
componyx.UI.Base.WebComponent
|
HTMLElement
required :boolean
Gets or sets a value indicating if the field is required.
Type:
role :string
Gets or sets the role identifier for the field, defining its purpose or behavior.
Type:
ruleCases :Array.<RuleCase>
Gets or sets a list of rule cases.
Type:
validationSettings :ValidationSettings
Gets or sets the validation settings of the field.
Type:
viewAsLabel :boolean
Gets or sets a value indicating if the field value is displayed as a label when in view mode.
Type:
viewElement :HTMLElement|null
Gets the rendered view element.
Type:
viewElementId :string|null
Gets or sets the id of the view HTML Element from which the attributes are cloned.
Type: