LinkedIn
Copied!

Table of Contents

Configuration options for the Text control

Learn about the text control configuration options that you can use to customize the control. For example, you can select the format of the data that is displayed, specify visibility of the control, assign an ID for the testing purposes, and fine-tune the styling of the control.

General

By using the options on the General tab you can, for example, reference a property that sources data for the control, specify the visibility of the control or enter a label that describes the control.

Field Description
Property Specifies a property or a parameter to source the data for the control by using the following notations:
  • For parameters, the param.NAME notation, where NAME identifies a string parameter.
    Declare the same parameter as the one that you select on the Parameters tab, and that your application provides a non-blank value for the parameter value in all situations where the section appears.
  • For properties on pages other than the page that corresponds to the Applies To class of the rule, the pagename.propertyname notation.

    You can reference properties on any page that is listed on the Pages & Classes tab.

If the property that uses the Table Type field provides a set of possible values, specify a Single Value mode property that has a Table Type other than None.

Label Sets the name of the property as the label for the control. You can enter your custom text by clearing the check box.
Label value Specifies a custom label for the control.
Available only when you clear the Label check box.
Visibility Determines when to display the control:
Always
The control is always visible.
If not blank
The control is visible when the field is not empty.
If not zero
The control is visible when the field contains a value that is different from zero.
Condition (expression)
The control is visible based on you custom condition that you can create in the condition builder. For more information, see Using the Condition Builder to configure dynamic UI actions..
Condition (when)
The control is visible based on a when rule.

To include the section with the text control in the navigation of a portal, you can make the header visible only when a specific space is the current space, by entering an expression in the field. For example:

pyCurrentSpace=="ASpaceName"
Reserve space when hidden Adds a blank area which appears in the section when the text is hidden.
Available only when you select the Condition (expression) or Condition (when rule) visibility option.
Run visibility condition on client Activates dynamic evaluation of the condition each time the value of a property in the condition changes.
Available only when you select the Condition (expression) or Condition (when rule) visibility option.
Value Specifies the value that the control displays:
Property value
Displays the value of the property that is selected in the Property field.
Another property's value
Displays the value of the property that you select in the Value property field.
Constant
Displays the value that you enter in the Value constant field.
Display text of selected option
Displays the description of an option.
Localize property value
Displays the localized value of the property that you specify.
Field value
Specifies a field value that is defined in the application. If the field value is parametrized, you can display the specified set of field values in the adjacent field. For more information, see Keystores.
Wrap text Presents the label as multiple lines when the text is longer than the cell width. If this check box is not selected, the label might appear truncated at run time.

Identifiers

In the Identifiers section, you can assign an ID for a guided tour or the testing purposes.

Field Description
Tour ID Specifies a unique string that identifies the element as a stop during the creation of a guided tour. You can use numbers, letters, and underscores.
Test ID Specifies a unique string that identifies the UI element during automated testing. You can either generate an ID or enter a value that can include numbers, letters, and underscores.

You can view the test ID in HTML or at run time in the Live UI info panel.

The test ID is available to access groups that include the PegaRULES:TestID privilege. To disable test ID, remove the PegaRULES:TestID privilege from the access group.

Presentation

Field Description
Control format Determines the format of the control.
Label format Determines the format of the label.

Format

The options in the Format section specify the format in which the data is displayed.

Field Description
Type Read-only. Specifies the way in which the data is displayed. Your selection determines other available format options.

The following choices are available:

None
No formatting is applied to the property that is selected in the Property field.
Date
Renders the DateTime and Text property types in date-only format in which hours and minutes are not displayed. For more information, see Understanding the Date, Time of Day, and DateTime property types.
Date/Time
Renders the DateTime and Text property types in date and time format. For more information, see Understanding the Date, Time of Day, and DateTime property types.
Number
Specifies a numeric property, for example, for decimal places or a currency.
Text
Specifies unedited text in which you can use spaces, tabs, line break characters, and other control characters.
True/False
Renders the property as a boolean value, according to the conditions that you specify.
Text alignment Specifies left, right, or center alignment.
Available only when you set the Type option to Number.
Decimal places Controls the number of digits after the decimal place.

The default is Auto,, which displays a maximum of three decimal places (placeholder zeroes are not added). You can select 0 to remove all digits after the decimal point and round to the nearest integer or All to include all digits.

Available only when you set the Type option to Number.
Scale Determines a label that specifies the scaling applied to the number. The following scales are available:
  • K for thousands
  • M for millions
  • B for billions
  • T for trillions

For example, if you select Thousands, a value of 20,000 appears as 20 K.

Available only when you set the Type option to Number
Negative format Specifies the format for displaying negative numbers.

You can also specify a CSS class if you select one of the Style Ref options. By default, the class name is NegativeNumber.

Available only when you set the Type option to Number.
Symbol Available only when you set the Type option to Number. When a symbol is specified, the value is prepended an additional character.

You can use this option to select the way of representing the number:

Currency
Formats the number as a currency that is based on the default locale.
Constant
Formats the number as a text string or an ASCII character that you enter (for example, "%").
Reference
Displays the number as a property value.
Separators Specifies a separator for values of thousands. Depending upon the default locale, a comma or period is used.
Available only when you set the Type option to Number.
Obfuscated Hides user input by displaying graphic symbols. The input characters are initially added to the clipboard as unencrypted, clear text values. The system computes the hashed value only when the page is committed to the PegaRULES database. Then, the hashed value appears in both the clipboard and the database row.
Available only when you set the read-only Type option to Text.
Auto prepend Adds a property, a parameter, a field value with or without parameters, or a constant before the property value. For example, when the user name appears, the system automatically adds the user title.
Available only when you set the Type option to Text and the Obfuscated when parameter is set to Never.
Auto append Adds a property, a parameter, a field value with or without parameters, or a constant after the property value. For example, when the user name appears, the system can automatically add the full mail extension to the name.
Available only when you set the Type option to Text and the control is not obfuscated.
Show value as Labels the outcome of a boolean with text or an image.
Available only when you set the Type option to True/False

Advanced presentation options

The Advanced presentation options fine-tune the styling of the control.

Field Description
Cell read-write classes Adjusts elements in a cell by applying Cascading Style Sheet (CSS) helper classes. For example, you can use a CSS helper class to center an element in a cell or to double the default right margin for the element. You can click the Open helper class picker icon to specify one or more CSS helper classes to apply to this cell when the form is displayed in the read-write mode. You can enter several helper classes, and separate them by a space. Alternatively, you can enter the name of a custom style to apply to this cell. You can also enter a property or a parameter.
Cell read-only classes Adjusts elements in a cell by applying Cascading Style Sheet (CSS) helper classes. For example, you can use a CSS helper class to center an element in a cell or to double the standard right margin for the element. You can click the Open helper class picker icon to specify one or more CSS helper classes to apply to this cell when the form is displayed in the read-only mode. You can enter several helper classes, separated by a space. Alternatively, you can enter the name of a custom style to apply to this cell. You can also enter a property or parameter.
Inline style (not for production use) Defines an inline style that you can specify by entering CSS code.
Entering an inline style results in a guardrail warning. For maintainability and reuse, the recommended approach is to use read-write or read-only classes. For more information, see CSS helper classes.

  • Adding a Text control

    To help users understand the structure of a layout and get a general idea what the content groupings within the layout include, describe the content and the purpose of layout elements by including formatted text in cells and headers in a layout.

  • Controls

    Use control rules to determine the appearance of a single property, such as a button or drop-down field, on a form.

  • Applying a custom text input and formatted text format

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.