clearFormValue

Deletes a specific value from a form field/entry.

note

As the name suggests, this will clear the value. If a default value was initially supplied, this value is not restored.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"field" (required)	String	The name of the field to be deleted.	null
"form"	String	The name of the specified form in which the field has to be deleted. If no form is specified, the form of the active view is used.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Delete a value from a form

Show ExampleHide Example

Goal: Create a clearFormValue action clearing the name field in the contact form.

To achieve this the following code can be used:

{
  "type": "clearFormValue",
  "params": {
    "field": "name",
    "form": "contact"
  }
}

The field and form parameters specify which value is to be deleted from which form.