refreshSection
Refreshes a section. When refreshing a target section, the system refreshes all sections that share the name of the target section.
Signature
refreshSection(options)
Returns
Not applicable.
Parameters
| Name | Description | Type | Required |
| section | Specifies the name of the section that you want to refresh. By default, the API refreshes the section that contains the element that raises the event. | String | ❌ |
| event | Specifies the event that launches the activity. | DOM event object | ✅ |
| dataTransform | Specifies the name and parameters of the data transform. | JSON object | ❌ |
| activity | Specifies the activity that the section launches on refresh. | JSON object | ❌ |
| submitOnRefresh | Specifies if the system submits editable data from the form to the
clipboard. The default value is true. | Boolean | ❌ |
JSON objects
- dataTransform
- Includes an array of parameter objects.
isPropertyindicates whether the parameter is a property or a literal constant. The default value ofisPropertyisfalse, which means that the parameter is a constant.{ "name":"dataTransformName", "parameters":[ { "name":"param1", "value":"Page1.prop1", "isProperty":true }, { "name":"param2", "value":123, "isProperty":false } ] } - activity
- Includes an array of parameter objects.
isPropertyindicates whether the parameter is a property or a literal constant. The default value ofisPropertyisfalse, which means that the parameter is a constant.{ "name":"activityName", "parameters":[ { "name":"param1", "value":"Page1.prop1", "isProperty":true }, { "name":"param2", "value":123, "isProperty":false } ] }
Previous topic refreshHarness Next topic runActivity