Skip to main content

refreshSection

Suggest edit
Updated on April 22, 2022

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

NameDescriptionTypeRequired
sectionSpecifies 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
eventSpecifies the event that launches the activity.DOM event object
dataTransformSpecifies the name and parameters of the data transform.JSON object
activitySpecifies the activity that the section launches on refresh.JSON object
submitOnRefreshSpecifies 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. isProperty indicates whether the parameter is a property or a literal constant. The default value of isProperty is false, 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. isProperty indicates whether the parameter is a property or a literal constant. The default value of isProperty is false, which means that the parameter is a constant.
{
   "name":"activityName",
   "parameters":[
      {
         "name":"param1",
         "value":"Page1.prop1",
         "isProperty":true
      },
      {
         "name":"param2",
         "value":123,
         "isProperty":false
      }
   ]
}
For example:
var options = {      
              section: sectionName,
              event: eventObject,
              dataTransform: dataTransformJSONObject,
              activity: activityJSONObject,
              submitOnRefresh: boolean
          }; 

          pega.api.ui.actions.refreshSection(options);
Did you find this content helpful? YesNo

Have a question? Get answers now.

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

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