Harness and Section forms
Adding a Tree Grid layout

Field

Description

• The When Name key part of a when condition rule. Click() to review or create the rule.
• Simple expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators, such as .Color="Red". You can combine the expression with a when condition rule or another expression using the && and || operators.

As a best practice, use the Condition Builder to edit this field. Click ( ) to open the tool. See Using the Condition Builder to configure dynamic UI actions.

• Leave blank so that the state of the layout (expanded ( ) or collapsed ( ) when you save the Harness, Section, or Flow Action form becomes the state upon initial runtime presentation.
• The When Name key part of a when condition rule. Click() to review or create the rule.
• Simple expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators. For example, enter .Color =="Red"

Appears when you enter a simple expression in the Visible When field.

Select to cause evaluation and execution of the condition each time the value of a property stated in the condition changes. If unselected, the expression is evaluated and the condition executed when the form is initially presented and whenever the form is refreshed.

By default, controls that allow typing, such as Text Input, are evaluated when the user leaves the field. To re-evaluate conditions as the user types, use the Apply Conditions action with a Keyboard event. See Control Form — Completing the Control tab.

Appears for Tabbed or Accordion values of the Header Type. Select this option if you want the system to retrieve only the data necessary for the current tab or accordion display. When another tab or accordion is selected, the system will retrieve further data for it. This option speeds up first display of the page.

To enable users to take actions, such as submit, on a work item while other content is still being loaded, configure sections to use defer loaded asynchronous declare pages. See PDN article How to configure non-blocking UI using Asynchronous Declare Pages (ADP).

If this is the only tab in a group, this option is selected by default and cannot be changed.

If this is the only accordion in a group, this option is selected by default and cannot be changed.

Optional. If the data results comprise more than a single page (approximately 20 rows of data), you may want to specify a traditional Paging format. This option is not available if the data source is a report definition.

The system retrieves a segment, known as a page, containing the number of rows defined in the Items per Page setting, from the total data set on the clipboard. It presents the page navigation controls in a format defined in this option. You can drag and drop rows within a page.
When you select a paging option, the paginate gadget (pyGridPaginator section) is automatically added to the right-most cell in Action Top. You can drag and drop the gadget onto any cell in an action area (do not drop into the repeating area).
Note: If the results produce less than one page, the paginate gadget does not appear at run time.

The options are:

Note: In cases where the data set is large and performance is an issue, you can populate the clipboard incrementally using the Paginate Activity on the Advanced tab.

Select a style for the repeating area elements (text, borders, backgrounds, and images) as defined in the Skin rule. To modify the styles, open the Styles tab of the Skin rule and select Layouts>Repeat Tree/Grid. Specify the skin in your Designer Studio General Preferences panel.

The initial settings are as follows:

• Default
• Spreadsheet
• Transparent

To add a header image at the top of the Tree:

1. Open its property panel for this field to start the Image Catalog (a pop-up version of the Image Library landing page).
2. Search for the image you want to use by entering a text string in the Search field and clicking Find.
3. Select an image from the resulting display: at the top right of the panel details about the image appear.
4. To use the selected image, click OK.

Note: The image must already be present in a binary file rule that is part of your application; you cannot search your local computer or the Internet through the Image Catalog.

Appears when you have selected a header image. Add text here to describe the image: those using assistive devices will hear this title although they may not be able to perceive the image.

Optional. Appears if you selected a paging option in the Paging field on the General tab.

Select a custom activity that populates the clipboard from a Page List in a page size you define. Because the activity limits clipboard size, this option is useful when retrieving large amounts of data from an external Web service or database. You can also use this activity to control sorting and filtering behavior.

For guidance on configuring the parameters in your activity, use a copy of the standard template activity pyTemplateAdvancedGridActivity.

• The When Name key part of a when condition rule. Click to review or create the rule.
• Simple expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators, such as .Color="Red". You can combine the expression with a when condition rule or another expression using the && and || operators.

As a best practice, use the Condition Builder to edit this field. Click to open the tool. See Using the Condition Builder to configure dynamic UI actions.

The edit mode sets the default presentation and behavior configuration for a repeating grid, determining how users view and edit properties.

By default, each edit mode is configured with grid actions — events and associated actions. The default action for all edit modes is Click to Set Focus. If you do not want a grid to have focus, for example, a display-only grid, delete this grid action.

You can add, delete, or edit grid actions as desired; click next to Edit Mode to configure grid actions. See Completing the Control tab for a description of actions.

Note: When configuring actions in a repeating grid, select the actions from the Handle List Items category. These actions are pre-configured to act upon the rows of the grid.

You can configure sequential actions based on a single event for a repeating grid; for example, Click to Set Focus and Click to Edit Item. The actions are acted upon in the order specified. You can also set multiple actions based on different events; for example, Click to Set Focus and Double Click to Edit Item.

You can also configure Keyboard actions to enable users to navigate and access items in a repeating grid. For example, you can configure the Up and Down arrows to set focus to the previous and next rows in a grid, and the Enter key to open the selected item.

For more information about edit modes, see PDN article About repeating layout edit modes.

Note: The UI Gallery contains working examples of edit modes and grid actions. To view and interact with examples and review configurations, select Designer Studio> User Interface > UI Gallery and select Tree Grid in the Repeating Layouts group or Row Actions in the Combinations group.

Select one of the following Edit Modes. See Completing the Control tab for a description of actions.

The system uses existing grid actions to determine whether to set focus to new rows.

Note: If you want to set focus from within a row in a repeating grid to an editable control outside of the grid, provide the full path to the property, beginning with the parent page, and represent it on the Pages & Classes tab of the layout containing the repeating grid.

For Modal Dialog and Embedded Pane, click next to the field to open the template section used to render the layout. By default, the templates are standard rules .pyGridModalTemplate and .pyGridDetails. To create custom templates, copy these rules into your Applies To class. Do not change the Purpose.

Depending on the mode you select, you will see a different array of the following fields:

Appears if edit mode is Modal Dialog or Embedded Panel, or Read Only and Show Details is selected. Select or create the flow action that will provide the form for the modal dialog or detail area that appears when the user clicks a row.

Appears if the Edit Mode is Modal Dialog or Embedded Pane. Select to allow the user to view the flow action details in read-only mode, which prevents locking the work item (Work- or Assign- item) when it opens.

Caution: Do not select this option if the flow action contains an editable grid. The user will be unable to perform work in it.

Select to allow users to move objects higher or lower on the display by dragging and dropping individual rows. Depending on the properties of the objects the rows represent, rows may be moved above or below other rows, or dropped into a row that can receive them to become child entries of that row.

Note: This option is unavailable when the data source is a Report Definition.

Visual indicators give clues about the process: a line appears between two rows in the list if that is where the row you have started dragging will appear if you release it. A row that can receive the row you have selected as a child will change background color. If your mouse pointer is over an area where you cannot drop the row you have selected, an indicator will remind you that the area is not a valid target. If you attempt to drop the row there, the display will remain unchanged.

Select to allow users to adjust the width of columns on the display by dragging individual columns to the left or right.

Select to allow users to click a row border and drag it beyond the Height setting in the Row Properties panel.

Select if you want an OnHover style for rows, changing the appearance of a row when the pointer hovers over it. You can set the hover text and background color in the Skin rule.

Note: The UI Gallery landing page contains working examples of Row Hover. To view and interact with examples and review configurations, select Designer Studio> User Interface > UI Gallery and select Tree in the Repeating Layouts group.

Select to allow users to show only those rows that match a column value filter. This setting enables filtering for all columns that include a property. You can set filter types or disable filtering for individual columns using the Filtering options in the Column Properties panel.

If a column can be filtered, a filter icon ( ) appears on the right side of the column's header cell. The user clicks the icon to display the filter pop-up menu. On the menu, the user selects the check box next to each property that will be included. Users can select more than one filter criteria and the grid will filter using all selected criteria.

Filtering mechanisms also appear in the menus for data sourced from:

• static report definition

• dynamic report definition

• virtual report definition

• property

• data page

When finished, the user clicks Apply. The filter icon changes to a filter-on icon () indicating that a filter is applied to the column.

You can use the Skin rule to replace the default icons.

Note the following:

— Columns containing images, action controls such as buttons or icons, hidden controls (pxHidden), prompt select controls, and subsections cannot be filtered.

— Filtering on Text properties that are obfuscated in edit-mode return results based on unfiltered data. Filtering should be disabled.

— Null and not null values can be entered in the filter panel in the Report Viewer. An error message displays if the user searches for a date range by entering a From date that is later than the To date in the Data time column filter panel. An error message displays when the value entered in Greater than or equal to is greater than Less than or equal to.

— The following property types cannot be filtered:

• TextEncrypted
• Password
• TimeOfDay
• Identifier

Note: If the filter does not produce results, a message appears. You can modify the message text in the section pyGridNoResultsMessage.

Appears if edit mode is Read Only. Select to allow the user to click a row and display its flow action details beneath the row in read-only mode. The user can expand multiple rows. Enter the flow action in the Flow Action field.

Note: Unavailable if source is Report Definition. Clicking a node opens the Report Viewer.

Appears if Show Details is selected. Select to display details for all rows when the user opens the form.

Select to allow users to sort the rows on a column in the tree grid. This setting applies to all columns. You can disable sorting for individual columns by clearing the Enable Sorting check box in a column's Cell Properties panel. Sorting is not available for columns containing images, or controls such as buttons or links.

Note: Unavailable if source is Report Definition.

A tool tip appears at run time when the user hovers the mouse pointer over the column header. Clicking the header sorts the rows in the column. When sorted, an icon indicating an ascending () or descending () sort order appears to the right of the header label text. The user can alternate the sort order by clicking the header again. You can use the Skin rule to replace the default icons.

Note: Sorting is performed on all rows in the tree grid. If paging is enabled and the user changes the sort order, the tree grid view returns to the first page.

Select this option to specify the maximum height and width of the layout. Further fields appear:

Open on double-click

or

Open leaf item on double click

Appears if Edit Mode is Read Only or Embedded Pane. Select so that the related work item opens for editing in a work item gadget when the user double-clicks on a row of data in the display. If the Pega 7 Platform cannot find the gadget, it opens the work item in a new tab or new window.

For Report Definitions. Select so that when the user double-clicks a leaf item under a parent node, the item opens rather than the Report Viewer.

Appears when edit mode is Embedded Pane. Select a custom section in which you want the details to appear. For example, assume you want to display the detail area to the right of the grid instead of below it (default). Create a section (named gridResults) containing a two-column layout. Embed the grid in the first column and an empty section in the second column. Enter the name of the empty section in Target for Edit.

Specify the column width of this column in pixels. You can also adjust the width of a column directly:

1. Click a vertical wireframe cell border.
2. Wait until the pointer shape changes (), then drag the border.

The unlabeled Use at Run time check box to the right of the width field is enabled by default and cannot be edited. This forces the Width value to be used by the browser at run time, even when data values in this column or in other columns would otherwise cause the browser to present a wider or narrower column. Data values may sometimes wrap or appear truncated.

Label Column panel only. Clear the check box to disable sorting on this column . This check box appears only if the Enable Sorting check box is selected on the Tree Grid panel (overrides global setting).

Optional. Enter CSS code for an inline style for a cells in the column. For guided assistance in composing a style definition, click the magnifying glass icon () to open the Style Editor. You can select from predefined lists or type a style definition directly, and preview the results.

Select either a Property (default) or a list-type Report Definition as the data source. You cannot select a summary-type Report Definition.

If you specified Property, select the Page List property as the data source.

If you specified Report Definition, select the Applies To key part of the rule.

If you specified Report Definition, a list contains summary-type reports. Select the Report Name key part of the rule.

Optional. Click () in the properties panel to update parameter values that you want to pass from the grid to the Report Definition. Values are passed when the data is loaded, and when the report definition refreshed due to user actions.

See About Report Definitions.

1. Click a horizontal wireframe cell border.
2. Wait until the pointer shape changes (), then drag the border.

The unlabeled Use at Run time check box to the right of the width field is enabled by default and cannot be edited. This setting forces the Height value to be used by the browser at run time, even when data values in this column or in other cells would otherwise cause the browser to present a taller or shorter column.

• The When Name key part of a when condition rule. Click () to review or create the rule.
• Simple expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators, such as .Color="Red". You can combine the expression with a when condition rule or another expression using the && and || operators.

As a best practice, use the Condition Builder to edit this field. Click ( ) to open the tool. See Using the Condition Builder to configure dynamic UI actions

Select a Single Value property. Typically, this is from within data source's embedded page property. Alternatively, you can drag a property name from the properties visible in the Application Explorer onto the cell.

If the source is a summary type Report Definition, the system creates cells and populates each using Column Name properties defined in the rule. If there are joins in the report, property names appear as joinname.PropertyName.

Note: This field does not appear if the value in the Control field contains an Action mode control such as pxButton.

Many controls on the Basic and Advanced groups are associated with default controls, which appear in this field when you drag and drop a control into the cell. For example, the Button control populates the field with pxButton, the Text Area control with pxTextArea, and so on.

Note: This field does not appear if the value in the Control field contains an Action mode control such as pxButton.

• The When Name key part of a when condition rule. Click () to review or create the rule.
• Simple expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators, such as .Color="Red". You can combine the expression with a when condition rule or another expression using the && and || operators.

As a best practice, use the Condition Builder to edit this field. Click ) to open the tool. See Using the Condition Builder to configure dynamic UI actions

• The When Name key part of a when condition rule. Click () to review or create the rule.
• Simple expression based on the comparison of a pair of constants, properties, or both, combined by Boolean operators, such as .Color="Red". You can combine the expression with a when condition rule or another expression using the && and || operators.

As a best practice, use the Condition Builder to edit this field. Click ) to open the tool. See Using the Condition Builder to configure dynamic UI actions

Specify the width of this column. Select the check box to the right of the field to lock the width to the value you have specified.

Clear the Use at Run time check box (unlabeled) next to the width field to allow the browser at run time to determine the width of this column based on the size of the column contents and the size of other columns. The width may vary from use to use depending on the contents of this cell and other cells. (When cleared, the generated HTML for this column includes a <TD> element with no WIDTH= attribute.) The Width value is used as you view the rule form, but not at run time.

For example, clear this check box if the cell is to contain a section that may be wide in some situations and narrow in others.

Select the Use at Run time check box to force the Width value to be used by the browser at run time, even when data values in this column or in other columns would otherwise cause the browser to present a wider or narrower column. If checked, data values may sometimes wrap or appear truncated.

Optional: Enter CSS code for an inline style for a cells in the column. For guided assistance in composing a style definition, click the magnifying glass icon () to open the Style Editor. You can select from predefined lists or type a style definition directly, and preview the results.

• Auto — displays a check box for each unique value and the Search or Date Range fields, depending upon the column data type. This is the default.
• Range/Search — displays only the Search or Date Range fields, depending upon the column data type. Use this option to enable Search or Date Range on columns in which the values are unique, for example, a description.
• None — no filtering is available on this column.

Appears and selected by default if Sorting in the Tree Grid properties panel is selected. Clear the check box to disable sorting on this column.

Clear the Use at Run time check box (next to the height field and (unlabeled) to allow the browser at run time to determine the height of this row based on the size of the row contents and the size of other rows. The height may vary from use to use depending on the contents of this cell and other cells. (When cleared, the generated HTML for this column includes a <TD> element with no HEIGHT= attribute.) The Height value is used as you update the rule, but not at run time.

For example, clear this check box if the cell is to contain a section that may be tall in some situations and short in others.

Select the Use at Run time check box to force the Height value to be used by the browser at run time, even when data values in this column or in other cells would otherwise cause the browser to present a taller or shorter column.

Optional. Enter CSS code for an inline style for a cells in the column. For guided assistance in composing a style definition, click the magnifying glass icon () to open the Style Editor. You can select from predefined lists or type a style definition directly, and preview the results.

Select to display all the cell values in the row with the same style that the column heading uses. This is an alternative to individually selecting the Use Heading Styles check box for each column. This option is unchecked by default.

Field

Description

Select the format you want to apply to the tabs in the group. To configure the format's appearance, access the Components tab in the Skin and then select Tab in the Layouts area.

• Standard — Default format applied to all tab groups.
• Sub — Format suitable for sub-tabs.
• Other — A custom style that you create in the Skin rule. When you select this option, enter the style name in the Style field.

See Skin form — Components tab — Layouts — Tabs.

Field

Description

Select the placement of the tabs at run time:

• Top
• Bottom
• Left
• Right

If you select Left or Right, specify the horizontal or vertical orientation of the tabs in the Tab Orientation field