Skip to main content

Text input control - General tab

Suggest edit Updated on December 13, 2021
Applicable to Theme UI-Kit applications

A cell in a layout can present the value of a property, as display-only or as an input field. When you add a Text input control, you can complete the General tab.

FieldDescription
PropertyPress the down arrow to select a property reference that identifies a single text value.
Label

Select to use the default label for the property or specify your own label. select or create a label. Use SmartPrompt to select a field value rule if you plan to localize the text. See About the Localization wizard.

Default valueOptional. Enter a constant value for the property value, a property reference, or an expression, to be used only when the user form or flow action form appears in read-write mode rather than read-only mode.
PlaceholderSelect None if you do not want to display placeholder text.
Helper text

Select one of the following options to display helper text for the control:

  • None – No helper text is provided.
  • Always visible / In-line – The helper text is always visible directly below the control.
  • Help icon with overlay on hover – The helper text is visible when the user places the mouse pointer over the help icon for the control.
  • Tooltip (not recommended) – The helper text is visible when the user places the mouse pointer over the control.

When you select one of the options to show helper text, an empty field is displayed directly below the Helper text field. Enter the helper text for the control in this blank field.

Visibility

To control the visibility of the label, 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 the Open condition builder 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 using the && and || operators.
  • Condition (when) : the region is visible under the specified condition. In the field that displays, select a when rule. Click the Open icon to create a new when condition or review an existing when condition.

If 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.
DisableSpecify a condition for disabling the text input:
Required This box appears only for fields in cells on flow actions and sections. Select to require that (when the form appears at runtime in read-write mode) users cannot successfully submit the form if the field is blank.

Selecting Required marks the label for this field with an orange asterisk when the flow action form appears in read-write mode. (The asterisk also appears if the Label control's Value For field is not blank and the Label control's Required box is checked.)

For sections, checking this box enables client-side format validation when this section is part of a harness form that has the Enable Client Side Validation box selected on the HTML tab. At runtime, users who leave this field blank and submit the form are notified immediately that the field is required; the form is not transmitted to the server.

Tour ID Optional: Provide an ID for use in a guided tour. Use a combination of numbers, letters, and underscores. Pega Platform 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 to better support automated testing of your application.

When creating a control that supports you can use a combination of numbers, letters, and underscores, or click the Generate ID button to create a unique ID. The attribute data-test-id is then generated for the selected element.

After the test ID has been 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.

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

Did you find this content helpful? YesNo

Have a question? Get answers now.

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

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us