This content has been archived.

Table of Contents

refreshSection: Public JS API for control actions

refreshSection

Refresh the current section or the named section. When refreshing a named section all sections with that name on the harness will be refreshed.

Syntax

var options = { section: sectionName,
event: eventObject,
dataTransform: dataTransformJSObject,
activity: activityJSObject,
submitOnRefresh: booleanVal
};

pega.api.ui.actions.refreshSection(options);

Parameters

This API accepts a JavaScript object which can have the following key-values:

  • section: Optional. The name of the section to refresh. When not set, the section containing the element that raised the event will be refreshed.
  • event: The event refers to a DOM eventObject.
  • dataTransform: Optional. This is a JSObject with the following key-values:

{name: “dataTransformName", parameters: [{name: "param1", value: "Page1.prop1", isProperty: true}, {name: "param2", value: 123, isProperty: false}]}

  • activity: Optional. This is a JSObject with the following key-values:

{name: “activityName", parameters: [{name: "param1", value: "Page1.prop1", isProperty: true}, {name: "param2", value: 123, isProperty: false}]}

  • submitOnRefresh: Optional. This is a boolean value which can be set to true to submit editable data on the form to the clipboard. The default value is true. In this case the user-modified data will always be saved to clipboard.

 

Suggest Edit

62% found this useful

Have a question? Get answers now.

Visit the Pega Support Community to ask questions, engage in discussions, and help others.