Rich Text Control Settings

Add a control that displays HTML-formatted text.

Control Description

The Rich Text control displays HTML-formatted text and images. Use the What-You-See-Is-What-You-Get (WYSIWYG) editor to display a variety of text styles for the Request participant. Reference an image to display in the Rich Text control using HTML syntax. See a design example.

Aside from rich text styles and images, the Rich Text control can display the following information regarding in-progress Requests:

  • Request data: Display the value of another control in the same or different Screen by referencing that control's Variable Value setting value using mustache syntax: encapsulate the Variable Name setting value between {{ and }} that represent mustache syntax. In doing so, you are referencing Request data. Spaces surrounding the Request data reference are allowed. During the Request, the Rich Text control references the Request data to locate that control's value to display it in the Rich Text control.

    Include your own HTML syntax in the Rich Text control along with Request data references. Example: Full Name: <p>{{ FullName }}</p>

  • Magic Variable values: Display the value of a Magic Variable by referencing the Magic Variable using mustache syntax. Example: {{ _user.fullname }}. Spaces surrounding the Magic Variable reference are allowed.

Permissions

Your user account or group membership must have the following permissions to design a Screen unless your user account has the Make this user a Super Admin setting selected:

  • Screens: Edit Screens

  • Screens: View Screens

See the Screens permissions or ask your Administrator for assistance.

Add the Control to a Screen

Follow these steps to add this control to the Screen:

  1. View the Screen page to which to add the control.

  2. Drag the Rich Text icon into the Screen Builder canvas. Existing controls on the Screen Builder canvas adjust positioning based on where you drag the control.

  3. Place into the Screen Builder canvas where you want the control to display on the Screen.

  4. Configure the Rich Text control. See Settings.

  5. Validate that the control is configured correctly. See Validate Your Screen.

Below is a Rich Text control in Preview mode.

Settings

The Rich Text control has the following panels that contain settings:

Configuration Panel Settings

Click the control while in Design mode, and then click the Configuration panel that is on the right-side of the Screen Builder canvas.

Below is the setting for the Rich Text control in the Configuration panel:

Content

Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to enter your text. Reference images in your content using HTML syntax. The WYSIWYG rich text editor also supports mustache syntax. Your text and/or images display in the Content setting using HTML syntax.

Ensure that all Rich Text controls implemented in a Conversational-type Screen contain content in their Content settings. See Controls in Conversational-Type Screens Require Labels.

Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:

    1. Select the required text from the Rich Text control.

    2. In the URL setting, enter the destination URL.

    3. In the Text to display setting, edit or enter the text displayed in the Rich Text control.

    4. In the Title setting, enter the text to display when a user hovers over the displayed text.

    5. From Open link in… drop-down menu, select one of these options:

      • New window: Select this option to open the destination page in a new browser window.

      • Current window: Select this option to open the destination page in the current browser window.

  • Format text: Follow these guidelines to format text:

    • Headings: From the Formats menu, select Headings and then select a heading size.

    • Bold: Do one of the following:

      • From the Formats menu, select Inline and then Bold.

    • Italics: Do one of the following:

      • From the Formats menu, select Inline and then Italic.

    • Underline: From the Formats menu, select Inline and then Underline.

    • Strikethrough: From the Formats menu, select Inline and then Strikethrough.

    • Superscript: From the Formats menu, select Inline and then Superscript.

    • Subscript: From the Formats menu, select Inline and then Subscript.

    • Code: From the Formats menu, select Inline and then Code.

    • Paragraph: From the Formats menu, select Blocks and then Paragraph.

    • Blockquote: From the Formats menu, select Blocks and then Blockquote.

    • Division: From the Formats menu, select Blocks and then Div.

    • Preformatted: From the Formats menu, select Blocks and then Pre.

    • Select one of the color swatches from the color palette. The selected text changes to that color.

  • Align text: Follow these guidelines to align text:

    • Left align: Do one of the following:

      • From the Formats menu, select Align and then Left.

    • Center align: Do one of the following:

      • From the Formats menu, select Align and then Center.

    • Right align: Do one of the following:

      • From the Formats menu, select Align and then Right.

    • Justify: Do one of the following:

      • From the Formats menu, select Align and then Justify.

Render HTML from a Variable

Advanced Panel Settings

Click the control while in Design mode, and then click the Advanced panel that is on the right-side of the Screen Builder canvas.

Below are settings for the Rich Text control in the Advanced panel:

Visibility Rule

Do not to use visibility rules with Email-type Screens. Some email clients that do not render natively from a web browser, such as Microsoft Outlook or Mozilla Thunderbird for the desktop, alter the HTML during rendering and may break visibility rules.

Note the following regarding how to use visibility rules:

Device Visibility

Select on which device types this control displays:

  • Desktop: The control displays only on desktop devices. Enable the Show for Desktop toggle key.

  • Mobile: The control displays only on mobile devices. Enable the Show for Mobile toggle key.

CSS Selector Name

See the following best practices regarding custom CSS in Screens:

Last updated

© Copyright 2000-2024 ProcessMaker Inc. All rights reserved.