setFormValue

Sets a specified value to a form layer with the specified name (key).

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
"form"	String	Name of the form (Only for named forms).	null
"key" (required)	String	Name of the form value.	null
"value" (required)	String	Value of the form value.	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: Set a form value

Show ExampleHide Example

Set the value for the specified form to the current year.

{
  "type": "setFormValue",
  "leadingDelimiter": "{$",
  "trailingDelimiter": "$}",
  "dynamicParams": {
    "year": {
      "left": {
        "context": "date"
      },
      "transform": "formatDate",
      "right": "YYYY"
    }
  },
  "params": {
    "form": "formActionsForm01",
    "key": "formActionsValue01",
    "value": "{$year$}"
  }
}

Example 2: Set multiple form values

Show ExampleHide Example

Set multiple values for different keys of the specified form.

{
  "type": "setFormValue",
  "leadingDelimiter": "{$",
  "trailingDelimiter": "$}",
  "dynamicParams": {
    "year": {
      "left": {
        "context": "date"
      },
      "transform": "formatDate",
      "right": "YYYY"
    }
  },
  "params": {
    "form": "formActionsForm02",
    "key": "formActionsValue01",
    "value": "{$year$}"
  }
}

{
  "type": "setFormValue",
  "params": {
    "form": "formActionsForm02",
    "key": "formActionsValue02",
    "value": "Berlin"
  }
}

{
  "type": "setFormValue",
  "params": {
    "form": "formActionsForm02",
    "key": "formActionsValue03",
    "value": "35390"
  }
}