Column layout properties - General tab

Click the in the Column layout header to display the Column layout properties panel and then select the General tab.

Field

Description

Column template

Displays the selected column layout template. Choose a different column layout template from the list, if desired.

Column format

Select a layout format for the column layout. The formats available are dependent upon the column template you selected.

Select Other to select from additional column layout formats defined in the skin.

You can create and modify column layout formats in the skin. Skin form — Components tab — Layouts — Column Layouts.

Container format

Select a format for the container. Select Other to select from custom container formats defined in the skin.

Container style

Appears when you select Other as the Container format. Specify a custom container format defined in the skin.

Visibility

To control the visibility of the container, select one of the following:

  • Always: always visible
  • Condition (expression): the region is visible under the specified condition. In the field that displays, select a condition or click to open the Condition Builder. You can define a 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.
  • Condition (when): the region is visible under the specified condition. In the field that displays, select a when rule. Click to create a new when condition or review an existing when condition.

Advanced featureIf this section is to become part of navigation in a composite portal, you can make the header visible only when a specific space is the current space. Enter an expression here similar to the following:

pyCurrentSpace=="ASpaceName"

Then select the Run visibility condition on client check box.
Run visibility condition on client

Appears when you select Conditional Visibility and enter a simple expression in the field that displays.

Select the Run visibility condition on clientcheck box to cause dynamic execution of the condition each time the value of a property stated in the condition changes.

Display header and title

Enter text to appear in the header or subheader.

NoteIf you plan to localize the application using this rule so the application can support users in various languages or locales, choose the text carefully and limit the length to no more than 64 characters. When practical, choose a caption already included in a language pack, to simplify later localization. A field value rule with this text as the final key part is needed for each locale. See About the Localization wizard.

Container Settings  
Title Optional. Type text to display in the accordion header or subheader. This text may include directives or JSP tags, such as <p:r > or <pega:lookup >.

NoteWhen you plan to localize the application using this rule, so the application can support users in various languages or locales, choose the text carefully and limit the length to no more than 64 characters. When practical, choose a caption already included in a language pack, to simplify later localization. A field value rule with this text as the final key part is needed for each locale. See About the Localization wizard.

Include icon with title Select if you want to include an icon in the title bar.
Icon

Optional. Clickto open the Image Library landing page and select an image to include on the left side of the header.

Icon title

If you want to display a tooltip when the user hovers the mouse pointer over the icon, type a text string within quotations, for example, "Select to view list".

Body visibility

Select one of the following to determine visibility:

  • Always: always visible
  • Condition (expression): visible under the specified condition expression. In the field that displays, select a condition or click to open the Condition Builder. You can define a 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.
  • Condition (when): visible under the specified when condition. In the field that displays, select a when rule. Click to create a new when condition or review an existing when condition.

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

Run visibility condition on client

Appears when you select Conditional Visibility and enter a simple expression in the field that displays.

Select the Run visibility condition on clientcheck box to cause dynamic execution of the condition each time the value of a property stated in the condition changes.

Conditions are automatically re-evaluated when the user updates a property value. 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.

Defer load contents

Optional. Choose this option to delay loading at runtime of the section content until the user clicks the header. Deferring enables users to start using other parts of the page rather than waiting for this section to load.

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 How to configure non-blocking UI using Asynchronous Declare Pages (ADP).

Header type Choose the format to be used to present this header:
  • Bar — A horizontal bar that is always present. The section appears as a single horizontal strip; all labels and values visible on the strip.
  • Collapsible — A horizontal bar marked with an expand icon (expand) or collapse icon () that marks an area below the bar that users can expand or collapse (hide).
  • Fieldset — Provides no header area, but a border around the contents of the layout with a single text label. (This produces HTML FieldSet and Legend elements.)
Expand when Appears when the Header type is Collapsible. Specify the When condition that must be met to expand the content.
Specify a pre-loading activity Optional. If the Header type is Collapsible, you can specify an activity to be run, prior to loading, when the container is expanded by a click. This activity can compute property values and other aspects of the expanded container. As a best practice, create a defer loaded wrapper section with the retrieval activity (instead of having multiple defer loaded sections with wrapper activities.)
Tour ID Optional. Provide an ID for use in a guided tour. Use a combination of numbers, letters, and underscores. PRPC uses the Tour ID when it finds an anchor button during a tour stop anchor point.
Test ID

Optional. If authorized, you can provide a unique Test ID for use in your test suite in order to support better automated testing against any Pega application.

When creating a control that supports Test ID, the Test ID field is initially blank. Use a combination of numbers, letters, and underscores, or click the Generate ID button to create a time stamp as a unique ID. The attribute data-test-id is then generated for the selected element.

When you save an existing section, any supported controls that do not have a Test ID will have one automatically generated. You can override these with a custom ID at a later time.

Once generated, you can view your Test ID in HTML or display it in the Live UI panel.

You also have the option to have all controls that support Test IDs in a ruleset updated in bulk.

Test IDs are supported in the following elements:

  • Button
  • Link
  • Icon
  • Label
  • Formatted text
  • Text input
  • Text area
  • Auto-complete

NoteA standard, out-of-the-box developer role, PegaRULES:SysAdm4, includes the privilege for Test ID. To disable Test ID for this role, modify the pxTestID privilege.

Related topics Harness and Section forms - Adding a column layout
Column layout - Presentation tab
Actions tab
HTML5 Application Readiness
Skin form — Components tab — Layouts — Column Layouts