You are here: User interface > User interface rules > Harness and section forms > Harness and section forms - Adding a list-to-list control

Harness and Section forms
Adding a list-to-list control

Note: this control is deprecated in Pega Platform.

Use a list-to-list field to allow a user to make multiple selections from a drop-down list. For example, a meeting may involve a dozen people from a department that has 100 employees.

User interactions with a list-to-list control

By interacting with the icons or captions at the right of each list, you can add to, remove from, and sort the destination list. List elements added to the destination are removed from the source list.

You can continue to make changes to the list contents until the form is submitted.

For another example, see the PDN article How to add a list-to-list control to a flow action rule.

Five icons and captions control transfers between the two lists:

Icon	Caption	Description
	`Move all`	Add all entries in the source list to the destination list.
	`Move`	Add the selected entry or entries in the source list to the destination list.
	`Remove all`	Remove all entries from the destination list.
	`Remove`	Remove the selected entry or entries from the source list.
	`Sort asc Sort desc`	Sort the source list.
Three icons and captions allow you to reorder the target list:
Icon	Caption	Description
	`Move up`	Move up the selected entry in the target list by one position.
	`Move Down`	Move down the selected entry in the target list by one position
		Sort the target list.

You can use SHIFT+CLICK to make multiple selections in either list. You can also use Windows drag-and-drop operations to move selected items to or from either list. Standard Windows keyboard operations for selection also work.

By default, the target list can contain up to 200 list elements. Through a parameter, a developer can choose a larger or smaller limit.

Buttons and captions are dimmed (gray) when not available. The entire list-to-list control is dimmed when presented in read-only mode.

1. Plan and prepare

Identify the source list

Determine the name of the report definition or clipboard page (a Page List or class Code-Pega-List) that supplies the values for the source list.

When specifying a clipboard page as the source of values:

By convention, the class of the page is Code-Pega-List and in many cases the page is named pxResults. The embedded pages in the Page List can be of any class.
Determine whether the clipboard page will be available at runtime when the data is needed. For example, when the flow action or user form appears, is the work item ready to present the list with appropriate data, or do you need to build an activity to create it?
When planning to have an activity assemble the clipboard page, create an activity that creates a page corresponding to a Page List property to hold the source list. If the pages in the list correspond to persistent instances in a class, the activity can simply consist of a few steps, such as the Obj-Browse method optionally followed by the Obj-Filter method. At least one non-blank embedded text property is required on each page (for example pyLabel). Values for this property need not be unique.
Alter the flow rule or other application processing so that the activity executes before the user interface element that includes the list-to-list control is rendered. (For example, if the list-to-list control is to be part of a flow action form, you can identify the activity in the Before this Action Run Activity field on the Action tab.)

Identify the destination list

Identify the Page List property that is to hold the selected pages (the destination list). Usually the embedded pages of this property belong to the same class as the embedded pages of the source list (from the Report Definition or clipboard page). The destination list can have pages of a different class, however, in this case, you must make sure the source embedded properties are mapped to the target embedded properties, and that the mapped properties in the target are supported by the target class's data structure.

Optionally, the embedded pages of the Page List properties (for both source and destination) can contain a TrueFalse property with the reserved name pySelected. At run time, the initial display of the list-to-list control presents any items for which pySelected has value "true". This property has no other effect.

2. Drag and drop the control

From the Advanced control group, select the List to List control .

Drag the control. When the pointer changes shape to indicate that you can drop the layout, release the mouse button. If the cell is not empty, the dropped control replaces the current contents of the cell. Click the Gear icon to display the Cell Properties panel.

3. Complete the Cell Properties panel

Complete the Cell Properties panel that appears.

Enter parameters for the ListtoList control, to control these runtime elements:

ListToList

General tab

Field	Description
Property	Accept the default placeholder value @baseclass. pyTemplateListToList.
Label	Check the check box to accept the property default; or uncheck the check box and, in the field that appears, select or provide a label.
Label format	Select one of the available options.
Default value	Optional. Enter a constant value for the property value, a property reference, or an expression, to be used only when the user form or flow action form appears in read-write mode rather than read-only mode. Click the Gear icon to start the Expression Builder. Choose a default value that speeds data entry. When the system renders a harness or section in read-only mode (for example because the read-write mode requires a privilege that the current user does not hold), the default value does not appear, because data entry is not permitted.
Visibility	Select to determine when the property value is to appear. `Always` is the default. (If this setting is not applicable, the cell contents are blank.) Choose `Always, If Not Blank`, or `If Not Zero` to have the field appear or be hidden based on the property value at the time this area of the user form (section or flow action) is first presented or refreshed. This condition is checked only once. Choose `Other Condition` to make the visibility depend on a when condition rule or a Java expression. Check the Reserve space when hidden check box, if it appears, to have a blank area appear in the section when the paragraph is hidden. Caution: Do not make an input field invisible if your application expects user input on the field. When a user submits an HTML form, an input field that is not visible is not included in the HTTP details.
Behavior	Not used with List-To-List. The list-to-list control does not support the OnChange event.

Check the Required check box to make this a required field.

Presentation tab

Field

Description

Edit Options

Select an edit mode for this control. The edit mode of the control, specified here, takes precedence over section and harness settings.

Auto — the control uses the edit mode of the section or harness in which it appears. If the section is set to Read Only, then the control is Read Only. If the section is set to Auto, then the control uses the edit mode of the harness. For example, a New harness is editable, while a Review harness is read only.
Editable — the control is editable, regardless of the edit mode of the enclosing layout.
Read Only — the property value is presented in read-only mode always, or based on a when condition rule or client-side test, even when the enclosing layout is in read-write mode.

Advanced Options

Note: As a best practice, define custom styles in the skin. .

Cell read-write style — Type the name of the custom style, for example, custom_stylename, that you want to apply to this cell when the user form or flow action form appears in read-write mode.
Cell read-only style — Type the name of the custom style, for example, custom_stylename, that you want to apply to this cell when the user form or flow action form appears in read-only mode.
Cell inline style — Type CSS code to define an inline style. As a best practice, define custom styles in the skin. See Skin form — Components tab — General — Custom styles.

Parameters tab

Configuring parameters for this deprecated control is only supported in Internet Explorer.

Actions tab

See Actions.

Notes

Although the standard control ListToList exists, it supports the capabilities described in this topic only. Because of its non-standard capabilities, do not specify ListToList as the Display Property on the General tab of a Property form.

The generated HTML code for a list-to-list control is a resizable <TABLE > structure.

This control depends on hidden HTML fields (<INPUT TYPE="HIDDEN" ..>).

For advanced cases, you can bypass the steps described in this topic and create a section with hand-crafted HTML code containing the <pega:listtolist > JSP control, which offers many additional options beyond the parameters listed in Step 4 above. See ListToList JSP tag.

You can localize this control by overriding selected standard field value rules named @baseclass.pyMessageLabel.zzzzz and @baseclass.pyButtonLabel.zzzzz, where zzzzz is the default English text.

About Flow Actions

About Harnesses

About Sections

Open topic with navigation