Field
Description
- Standard Icon: select from a list of icons pre-configured with a default icon, tooltip, and action.
- Image
- External URL
- Property
- Icon Class
Appears if you select Standard Icon as the Icon Source.
Press the down arrow and select the standard icon that you want to display. Standard icons are pre-configured with an icon and a tooltip. Variants of the pxIcon control are also configured with actions; see Standard icon controls for details.
Appears if you select External URL as the Icon Source.
Type the URL that you want to display as the icon/image source.
Appears if you select Image as the Icon Source.
To search through binary file rules containing images, click the Gear icon to start the Image Catalog tool (a pop-up version of the Image Library landing page).
If the image is not already loaded to a binary file rule, create a binary file rule and upload the image to the binary file rule.
Appears if you select Image, External URL, or Property as the Icon Source. For images, this field displays only if the selected image is not a sprite (Treat Image As A Sprite is not selected on the Main tab of the image binary file.)
Select the image size:
- Auto: automatically sizes the image by allowing the layout to determine the width of the control area. Default.
- Custom: select to specify the width and height of the image in pixels in the Image dimension field.
Appears if you select Image as the Icon Source and the selected image is a sprite. (Treat Image As A Sprite is selected on the Main tab of the image binary file.)
Sprites typically contain columns of images, representing each icon in normal, hover, and disabled states. Press the down arrow to select the column number of the image that you want to display.
Appears if you select Icon Class as the Icon Source.
Specify the class of the icon.
To learn how to upload your own icon fonts into an application, see the PDN video tutorial Implementing icons fonts in Pega applications.
Appears if you select Property as the Icon Source.
Press the down arrow to select the property that you want to use as the source of the image/icon. The property can be an internal binary file (Rule-File-Binary) or an external URL.
Specify a tooltip to display when the user hovers the mouse pointer over the image or icon. You can press the down arrow to select a property value or type the text that you want to display as the tooltip.
As a best practice, start the sentence with verb either in the imperative ("Enter price of item here") or as an infinitive ("To cancel the order, click here").
-
Always- the icon appearance is 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. Condition (expression)- specify the 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. Click the gear icon to create an expression.Condition (when rule)-specify the when rule that determines the visibility of this image or icon at runtime. Click the Open icon
to review or create the when condition rule.
Appears when Visibility is set to Condition (expression) or Condition (when rule) and the expression corresponding to the visibility mode chosen has been entered.
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.
Press the down arrow to select a privilege rule that controls the availability of this control at runtime.
If there is a privilege and a when rule (see Disabled field), both rules must evaluate to true for the icon/image to be available to the user.
Disable
Specify a condition for disabling the text input:
- Never – Never disabled
- Always – Always disabled
- Condition (expression) – The text input is disabled under the specified condition. In the field that is displayed, select a condition or click the Gear icon 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 by using the && and || operators.
- Condition (when) – The text input is disabled under the specified condition. In the field that is displayed, select a when rule. Click the Open icon to create a when condition or review an existing when condition.
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.
A 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.