ProcessMaker 4.1
ProcessMaker API Documentation
ProcessMaker Examples
Powered By GitBook
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 Required

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 ProcessMaker Screen

Follow these steps to add this control to the Screen:
    1.
    Create a new Screen or click the Edit icon
    to edit the selected Screen. The Screen is in Design mode.
    2.
    View the Screen page to which to add the control.
    3.
    Locate the Rich Text icon
    in the panel to the left of the Screen Builder canvas.
    4.
    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.
    5.
    Place into the Screen Builder canvas where you want the control to display on the Screen.
    6.
    Configure the Rich Text control. See Settings.
    7.
    Validate that the control is configured correctly. See Validate Your Screen.
Below is a Rich Text control in Preview mode.
Rich Text control in Preview mode

Move the Control on the Page

After adding a control to a Screen page, you may move it to another location on that page such that it is above or below other controls placed on that page. A control cannot be moved to another Screen page.
Follow these steps to move a control to another location on that Screen page:
    1.
    Place your cursor anywhere on the control not displaying the Duplicate Control
    or Delete Control
    buttons.
    2.
    Hold your cursor, then drag the control above or below other controls on that Screen page. Screen Builder previews where the control would display on the page based on how you position the control above or below other controls. If the control cannot be placed in a location because your cursor is above an existing control or too far to the left or right of the page, the
    icon displays in the preview.
    3.
    Place the control at the location on the page you want it. The other control(s) on the page automatically adjust position.

Copy the Control with its Settings

Copying a control also copies the current settings of that control. The copied control displays below other controls placed on that Screen page.
Follow these steps to copy a control:
    1.
    Select the control to be copied.
    2.
    Click the Duplicate Control button
    . The control copies with its current settings, and then displays below other controls placed on that page.

Delete the Control from a ProcessMaker Screen

Deleting a control also deletes configuration for that control. If you add another control, it will have default settings.
Follow these steps to delete a control from a Screen page:
    1.
    Select the control to be deleted.
    2.
    Click the Delete button
    . The control deletes. Other controls on that Screen page adjust their locations automatically.

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

Enter the text and/or image to display in the Rich Text control using HTML syntax (see a design example) and/or mustache syntax. Rich text editor is the default value. See this control's description for information how to use mustache syntax.
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.
What-You-See-Is-What-You-Get (WYSIWYG) rich text editor
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
    Undo changes: Click on the
    icon to undo the last action.
    Redo changes: Click on the
    icon to redo the last undone action.
    Insert/Edit links: Click on the
    icon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
      1.
      Select the required text from the Rich Text control.
      2.
      Click on the
      icon. The Insert/Edit Link screen displays.
      3.
      In the URL setting, enter the destination URL.
      4.
      In the Text to display setting, edit or enter the text displayed in the Rich Text control.
      5.
      In the Title setting, enter the text to display when a user hovers over the displayed text.
      6.
      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 editor toolbar, select the
        icon.
        From the Formats menu, select Inline and then Bold.
      Italics: Do one of the following:
        From the editor toolbar, select the
        icon.
        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.
    Change text color: Use the Text Color drop-down to change text color. Click on the
    icon. The color palette displays. Do one of the following:
      Select one of the color swatches from the color palette. The selected text changes to that color.
      Click the
      icon to select a custom color from the Color Picker.
      Click the
      icon to reset the text to its default color.
    Align text: Follow these guidelines to align text:
      Left align: Do one of the following:
        From the editor toolbar, use the
        icon to left- align text.
        From the Formats menu, select Align and then Left.
      Center align: Do one of the following:
        From the editor toolbar, use the
        icon to center-align text.
        From the Formats menu, select Align and then Center.
      Right align: Do one of the following:
        From the editor toolbar, use the
        icon to right-align text.
        From the Formats menu, select Align and then Right.
      Justify: Do one of the following:
        From the editor toolbar, use the
        icon to justify text.
        From the Formats menu, select Align and then Justify.
    Insert a bullet list: Use the
    icon to format text as a bulleted list.
    Insert a numbered list: Use the
    icon to format text as a numbered list.
    Indent text: Click on the
    icon to increase text indenting.
    Outdent text: Click on the
    icon to decrease text indenting.

Render HTML from a Variable

Select the Render HTML from a Variable setting to not show HTML syntax, but instead render the HTML syntax. If the Render HTML from a Variable setting is not selected, then the Rich Text control displays the HTML syntax. If a Request variable from which the Rich Text control references its data contains HTML syntax, select this setting to render that HTML.

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

Enter an expression that indicates the condition(s) under which this control displays. See Expression Syntax Components for "Visibility Rule" Control Settings. If this setting does not have an expression, then this control displays by default.
Note the following regarding how to use visibility rules:

CSS Selector Name

Enter the value to represent this control in custom CSS syntax when in Custom CSS mode. As a best practice, use the same CSS Selector Name value on different controls of the same type to apply the same custom CSS style to all those controls.
See the following best practices regarding custom CSS in Screens:

Related Topics

Last modified 4mo ago