Class: TemplateField
The field with the form data, contains the value of the nested form. Internal use only.
Implements
Constructors
new TemplateField()
new TemplateField(
componentStore
,viewerStore
):TemplateField
Creates the nested form field with form data for the component.
Parameters
• componentStore: ComponentStore
the component settings.
• viewerStore: IStore
viewerStore the form viewer settings.
Returns
Properties
componentStore
readonly
componentStore:ComponentStore
the component settings.
touched
touched:
boolean
=false
Flag, true, if the field is marked as touched.
Implementation of
valued
valued:
string
=''
The name of the component property that contains the field value.
Implementation of
viewerStore
readonly
viewerStore:IStore
viewerStore the form viewer settings.
Accessors
errors
Get Signature
get errors():
Record
<string
,unknown
>
Contains a field validation errors if the field provides multiple errors (i.e. field is template). Contains an array of field validation errors if the field contains an array of components.
Returns
Record
<string
, unknown
>
Contains a field validation errors if the field provides multiple errors (i.e. field is template). Contains an array of field validation errors if the field contains an array of components.
Implementation of
fieldType
Get Signature
get fieldType():
FieldType
The field type.
Returns
The field type.
Implementation of
form
Get Signature
get form():
ComponentData
Returns
the form for the field.
storeDataInParentForm
Get Signature
get storeDataInParentForm():
any
Flag, false if nested form data show as nested object, true otherwise.
Returns
any
Flag, false if nested form data show as nested object, true otherwise.
Implementation of
value
Get Signature
get value():
unknown
Value of the field.
Returns
unknown
Value of the field.
Implementation of
Methods
clear()
clear():
void
Clears the data in the field.
Returns
void
Inherit Doc
Implementation of
dispose()
dispose():
void
Releases allocated resources, must be used when destroying an object instance.
Returns
void
Inherit Doc
Implementation of
getValidationResult()
getValidationResult():
Promise
<undefined
>
Returns the validation results without triggering an events and changing the state of the form.
Returns
Promise
<undefined
>
the ValidationMessages validation results.
Implementation of
init()
init():
void
Initializes the value of the field.
Returns
void
Inherit Doc
Implementation of
reset()
reset():
void
Sets the field to its default value.
Returns
void
Inherit Doc
Implementation of
setError()
setError(
error
):void
Sets the error value.
Parameters
• error: unknown
Returns
void
Inherit Doc
Implementation of
setTouched()
setTouched():
void
Marks the field as touched.
Returns
void
Inherit Doc
Implementation of
setValue()
setValue(
value
):void
Sets the value of the field.
Parameters
• value: unknown
Returns
void
Inherit Doc
Implementation of
validate()
validate():
Promise
<void
>
Validates the field value.
Returns
Promise
<void
>