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.

Selectable tab on the List View form

Updated on April 5, 2022

Complete this optional tab to enable users to select at run time one or more rows of an embedded list view display and operate on the selected row or rows. For this capability, the list view display must be embedded in a section.

This facility can support list view displays embedded within flow action forms. For example, a flow action form can present a list of 40 optional contract terms and conditions that can apply to a corporate loan, each with a check box. The user can select which of the conditions apply to the loan application that is being processed.

Enable selection of rows Select display a check box or radio button for each row at run time. When you select this option, the Embedded option (on the Display Fields tab) is selected. You can identify a callback function on the Format tab to access the rows that the user selects.

If this check box is not selected, the other fields on this tab are ignored.


Mode Select one of the following options:
  • Single Select — The user can select only one row of the report at run time, by selecting one radio button. This mode is not supported if the Enable Paging box on the Organize tab is selected.
  • Multiple Select — A check box appears at the left of each report row. The user can select none, one, or more than one row of the report at run time. A check box also displays in the header row. Selecting the check box in the header row, selects the check box on every row. This mode is available whether or not the Enable Paging check box is selected.
Copy To Specify which clipboard page holds the properties that record user selections:
  • Content Page — User inputs are recorded in the pyRowSelected property on the Code-Pega-List pages created by the GetContent activity. (This choice is not available if the Enable Paging check box on the Organize tab is selected.)
  • PageList — This choice appears when you choose Multiple Select for the Mode field. The system records the user's choices of none, one, or multiple rows on pages of an embedded property of mode Page List, identified in the Name field. The system creates one page for each selected row.
  • Page — This choice appears when you choose Single Select for the Mode field. Properties from a selected row selected (by clicking a radio button) can be copied into an embedded page, or top-level page identified in the Name field.

If you choose Content Page, ensure that your application copies, saves, or acts on user selections quickly, because other processing might remove that page, or overwrite that page with the results of a list view report run later.

If you choose Page List or Page for the Copy to field, complete a row on the Pages & Classes tab to identify the class of the destination page or pages.

Name This field appears only when you choose PageList or Page for the Copy To field.

Specify a reference to a property of the indicated mode to contain details of user choices. To indicate that the property is directly on the step page of the calling activity, start the property reference with a period.

The reference can be the keyword primary followed by a period to refer to the primary page of the stream that includes the list view at run time, followed by a property name. In this case, enter primary on the Pages & Classes tab. For other cases, enter a fully qualified property reference, and identify the page that contains the property on the Pages & Classes tab.

An array appears only when you choose PageList or Page for the Copy To field. Identify the properties to copy from the GetContent page to the property identified on the Name field.

At run time, the .pyRowSelected Boolean property records user decisions. Any rows where this property has a true value are copied.

The .pxInsHandle property for a selected row is always copied. You do not need to list it in the array.

Source Property Select a property as a source. This property is from the pxResults(n) pages created by the GetContent activity.
Target Property Select a target property to hold the copied value of the source property.

Complete the Pages & Classes tab of this form to enable SmartPrompt for this field.

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. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us