Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

refreshSection: Public JS API for control actions

Updated on March 28, 2019

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.

 

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us