About the V5 URL control

Field

Description

Select a function for this URL, from the predefined values on the drop-down list.

Typically, select CUSTOM to define a URL with a custom function. See Placing an Icon in a Layout Cell (Built In Types) for a description of the other types.

Enter brief text that is to appear as the underlined blue link. (If this text is to be localized. enter no more than 64 characters. Click the pencil icon to review or create the field value rule supporting localization, with a middle key part of pyButtonLabel.

Optional. Enter a sentence or phrase identifying to users of the form the purpose and function of the URL. As a best practice, start the ToolTip text for an input field with a verb.

If this text is to be localized. enter no more than 64 characters. Click the pencil icon to review or create the field value rule supporting localization, with a middle key part of pyActionPrompt.

Field

Description

Do Action
Target

Window Width

Window Height

These fields appear only when the type is CUSTOM.

See Complete additional information for custom buttons below.

Select to determine when the URL appears. (If this setting is not applicable, the cell contents are blank.)

• Choose Always to have the URL appear or be hidden based on the visibility of the enclosing section or flow action when the form is first presented or is refreshed. This condition is checked only once.
• Choose Other Condition to make the visibility depend on a when condition rule, a Boolean expression evaluated only once, or a test evaluated repeatedly upon JavaScript events.

If you selected Other Condition for the Visible field, complete this field. Enter an expression involving another property, or identify the When Name key part of a when condition rule. Specify one of three outcomes:

• When condition rule — Enter the When Name key part of a when condition rule that determines the visibility of this field at runtime. The system uses the Applies To key part of the current rule in rule resolution to locate the when condition rule. Click the pencil icon () to review or create the when condition rule.
• Expression evaluated once — Enter an expression that returns true or false. This expression can involve multiple properties, function calls, and other syntax as supported by the <pega:when > JSP tag.
• Simple expression evaluated upon JavaScript events — To dynamically control the visibility of this property with a JavaScript event, enter a simple comparison involving a target property and select the Run on Client? box. The result at runtime determines whether the content of this cell appears in read-only mode or in the mode of the enclosing layout.
  For example, enter .Color =="Blue" in this field to make this field visible when the property Color has the value Blue, and invisible otherwise. Depending on the state of the Run on Client checkbox, the comparison can be executed only once as the form is initially displayed, or dynamically. See Implementing dynamic form actions and the Client Event Editor.

A URL that is not visible is also disabled and cannot be clicked.

Select to cause the text to wrap within the cell.

Select to cause the URL to be disabled or enabled based on a test, even when the form is in read-write mode. Complete the next field to modify the effect of this checkbox.

Optional. This field appears only when you select the Disabled? checkbox. Enter an expression involving another property, or identify the When Name key part of a when condition rule. Specify one of four outcomes, where true or blank means the URL is disabled.

• Leave blank to present the URL as disabled always, regardless of the mode of the enclosing layout.
• When condition rule evaluated once — Enter the When Name key part of a when condition rule that determines the mode of this URL at runtime. The system uses the Applies To key part of the current rule in rule resolution to locate the when condition rule, and executes the when rule once as it renders the form. Click the pencil icon () to review or create the when condition rule.
• Expression evaluated once — Enter an expression that returns true or false. This expression can involve multiple properties, function calls, and other syntax as supported by the <pega:when > JSP tag.
• Simple expression evaluated upon JavaScript events — To dynamically control the mode of this URL with a JavaScript event, enter a simple comparison involving a target property and select the Run on Client? box. The result at runtime determines whether the URL appears as disabled.
  For example, enter .Color =="Red" in this field to disable this URL at runtime when the property Color has the value Red, and enabled otherwise. Depending on the state of the Run on Client? checkbox, the comparison executes only once as the form is initially displayed, or dynamically. See Implementing dynamic form actions and the Client Event Editor.

This checkbox appears only if the Condition field contains a simple comparison.

Select to cause dynamic execution of the condition each time the value of the property mentioned in the condition changes. (Mark the field containing that property as a Client Event.) Leave cleared to cause the condition to execute only once, upon initial presentation of the form.

As a best practice, use SmartLayouts to achieve uniform width of cells throughout your application's forms. You can set the width of SmartLayout templates using the Skin rule. See Skin form — Styles tab — Layouts — Smart Layouts.

Optional. This field appears only when the cell is not controlled by SmartLayout column restrictions. Enter a positive number for the width in pixels of this cell. (At runtime, normal browser processing for rendering tables determines the actual displayed width.) You can also adjust the width this column directly:

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

As a best practice, use SmartLayouts to achieve uniform height of cells throughout your application's forms. You can set the width of SmartLayout templates using the Skin rule. See Skin form — Styles tab — Layouts — Smart Layouts.

Optional. This field appears only when all columns in the Layout are not controlled by SmartLayout column restrictions (that is, all columns have the None template). Enter a positive number for the height in pixels of this cell. (At runtime, normal browser processing for rendering tables determines the actual displayed height.) You can also adjust the height of a row directly:

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

Optional. Select the Privilege Name key part of a privilege rule that controls the availability of this URL at runtime. During rule resolution at runtime, the system uses the Applies To key part of the current rule as the first key part.

At runtime, the URL is not available to users who do not hold this privilege.

Click the pencil icon () to review or create the privilege rule.

Not used.

Optional. By default, when the user form or flow action form appears in read-only mode, the CSS style named LabelValueRead applies. You can enter another style name or select from those listed.

Click the pencil icon () to review the text file rule that defines the style sheet. Your application can override the standard style sheet in the text file rule webwb.user_work_form.css.

Select to change the style of this value to a table header style (by changing the element from <TD> to <TH>).

To apply inline styling to this cell only, type a CSS style definition in this field, or click the magnifying glass to access a Style Editor window. Styles you enter in this field supplement and override style elements defined in style sheets, according to normal CSS rules.

Inline styles are recorded in the generated HTML for the form; they do not alter the CSS definitions.

Using the Style Editor

You can select the font, color, font size, text align, vertical align, borders, margins, and other attributes of this cell using selection lists. The Style Editor maintains a preview of the resulting presentation. If you alter the style definition directly, click  Apply   to update the preview.

Click  OK   to record the style defined with the Style Editor in the panel.

Field

Description

Select an activity to execute when the URL is clicked. To find the activity at runtime, the system uses the Applies To key part of this rule as the initial Applies To key part of the activity. (For demonstration purposes, the default activity @baseclass.TemplateButtonActivity simply displays harness named @baseclass.TemplateButtonDisplay.)

If the activity selected accepts input parameters, the sources of parameter values can be set up now, or entered by a user at runtime. To define parameters here, click the magnifying glass button. Enter a constant value, property reference or expression for each parameter.

Select one:

• Current window — The custom activity presents a success message in the current window. To suppress this, the custom activity can call Work-.Show-Harness at the end to redisplay the entire user form.
• Pop-up window — The custom activity presents its results in a pop-up window. To suppress all results, choose this option and make the activity return an HTML stream that closes upon load.
• Custom Frame — The custom activity presents its results in a new frame.

If you selected Current window for the Target field, select this option to indicate that the custom activity does not require that the current form be submitted to run.

If you selected Custom Frame for the Target field, identify the name of the target window or frame.

If you selected Pop-up window for the Target field, enter an integer value to determine the initial width of the target window or frame, as a percentage of the entire window width. The default value is 20 percent.

If you selected Pop-up window for the Target field, enter an integer value to determine the initial height of the target window or frame, as a percent of the entire height of the window. The default value is 20 percent.