Represents a form element.
Form, FormAction, FormField, FormGroup, FormList, FormListItem
| Property | Description |
|---|---|
dynamicHtmlName: String (read-only) | Returns a dynamic html name for the field. |
formId: String (read-only) | The ID of the form element. |
htmlName: String (read-only) | Returns the global unique name of the field, which can be used as name in the html form. |
parent: FormElement (read-only) | The parent within the form. |
valid: Boolean (read-only) | Identifies if this element and all its children elements are valid. |
validationResult: FormElementValidationResult (read-only) | Provides a combined view on the validation status as per isValid() and getError(). |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| clearFormElement() | This method clears the whole form. |
| getDynamicHtmlName() | Returns a dynamic html name for the field. |
| getFormId() | The ID of the form element. |
| getHtmlName() | Returns the global unique name of the field, which can be used as name in the html form. |
| getParent() | The parent within the form. |
| getValidationResult() | Provides a combined view on the validation status as per isValid() and getError(). |
| invalidateFormElement() | The method can be called to explicitly invalidate a form element. |
| invalidateFormElement(String) | The method can be called to explicitly invalidate a field. |
| isValid() | Identifies if this element and all its children elements are valid. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
(read-only)Returns a dynamic html name for the field. It can be used to suppress any autocompletion support from a browser, e.g. for credit card related fields. It can be also used for a unique form name, if one form is used multiple times in a page.
(read-only)The ID of the form element. The is is unique within the parent element of the form.
(read-only)Returns the global unique name of the field, which can be used as name in the html form. For radio buttons this name is not unique.
(read-only)The parent within the form.
(read-only)Identifies if this element and all its children elements are valid. A form element, which was not submitted in the last request is always valid.
(read-only)Provides a combined view on the validation status as per isValid() and getError(). In addition it also provides the data as returned by the validation in case a validation script was used.
This method clears the whole form. After clearing a form it contains no value or the default value, is not bound to any business object and has the status of being valid.
Returns a dynamic html name for the field. It can be used to suppress any autocompletion support from a browser, e.g. for credit card related fields. It can be also used for a unique form name, if one form is used multiple times in a page.
Returns:
The ID of the form element. The is is unique within the parent element of the form.
Returns:
Returns the global unique name of the field, which can be used as name in the html form. For radio buttons this name is not unique.
Returns:
The parent within the form.
Returns:
Provides a combined view on the validation status as per isValid() and getError(). In addition it also provides the data as returned by the validation in case a validation script was used.
Returns:
The method can be called to explicitly invalidate a form element. The error text will be set to the one of two possible preconfigured custom error messages associated with the form definition. The "value-error" message will be used for FormField instances and "form-error" will be used for FormGroup instances.
The method can be called to explicitly invalidate a field. The error text is set to the given error message.
Parameters:
Identifies if this element and all its children elements are valid. A form element, which was not submitted in the last request is always valid.
Returns:
j