Rich Text Editor control

Control as an interface to edit Rich text

A Rich-text editor control is an interface for editing rich text within web browsers, which presents the user with a " what-you-see-is-what-you-get " ( WYSIWYG ) editing area. The aim is to reduce the effort for users trying to express their formatting directly as valid HTML markup.

Rich text editor control

Properties

UI properties

  • Label : Label is the text that is displayed above the text box and helps the user to understand what they are supposed to input in the text box.

  • Properties : These properties help you customize the Label by changing the text size, weight ( Light, Normal, Bold, Extra Bold, X Extra Bold), alignment (Left, Center, Right, Justified) and color of the label.

  • Type : The Type field is automatically generated depending upon the type of control used. In this case, it is a “dhq_richtext” type.

  • Unique Name : A Unique Name is used to uniquely identify a control in your App. Every control that is added on the screen gets an auto-generated Unique Name on the basis of the Label name given to the control.

  • Tooltip: This allows you to add the Tooltip text that would provide a hint to the user for providing input. The Tooltip icon would be visible if you switch on the Show tooltip icon toggle property available below.

  • Description: Is the description that you can add for your controls. The Description would only be visible if you switch on the Show Description toggle property available below.

  • Submit Data : This field lets you determine whether to send the value of the control or not in Workflow based on various control states. There are three conditions that could be set for this field.

    1. Always : When this condition is selected, the data in the control will be submitted irrespective of the state of the Rich Text Editor field.

    2. Never : When this condition is selected, the data in the control will never be submitted irrespective of the state of the Rich Text Editor field.

    3. No When Hidden : When this condition is selected, the data in the control will be submitted if the control is visible and not submitted when the control is hidden .

  • Required : When you select the required option, the field becomes a mandatory field and the user can not submit without filling it.

  • Read Only : When you select this option, the user will no longer be able to edit this field.

  • Show Tooltip Icon: This allows you to toggle switch ON or OFF to show or hide the tooltip icon where the tooltip text would appear.

  • Show Description: This allows you to toggle switch ON or OFF to show or hide the Description text.

  • Hidden : The hidden option helps you to hide the field from the user. This might help to perform some computation you don’t want the user to see or if you want to show certain fields only when a specific condition is met/not met.

  • Caching : When the caching option is selected and if a LOOKUP formula is applied to this control, the value that the LOOKUP returns will be cached and the user will be able to see this value in the Rich Text Editor field even when the user accesses the microapp later with no connectivity. This option is required when you want your app to be accessible in offline mode as well and getting the latest data from the sheets always is not critical.

  • Hide Label : This option hides the label of the Rich Text Editor field from the view.

  • Trigger dependents: When you Disable Trigger Dependents, it helps you to reduce or optimize the unnecessary evaluation of the dependent control’s formula. For a detailed explanation refer to this article here .
    By default, Trigger dependents is enabled. However, in complex apps by switching it off, you would limit the evaluation in the dependent control and in turn ensure quicker response times.

Properties

rich text viewer properties

  • ToolBar Style: This option provides a dropdown using which you can select the style of the toolbar that you wish to use in the microapp.
    There are 3 styles available for the way the Rich Text Editor Toolbar appears on the control.

    1. Classic (Default): Is the default style where the toolbar appears within the Editor.

      rich text editor classic

    2. Balloon: This type of toolbar appears as a balloon below the text to enable you to format the text.
      rich text editor balloon

    3. Inline: This type of toolbar appears Inline at the top of the control to enable you to format the text.
      rich text editor inline

  • Auto Height: This is used to enable or disable the height of the Embed control which if enabled would be automatically set. You can toggle to switch on or off to specify Auto Height setting. In case you switch off then the Height property would be enabled where you can provide the height accordingly in pixels or as a percentage or vw or vh (viewport width or viewport height).

  • Min Height: When you toggle switch ON the Auto height you would set the minimum height that should be maintained depending upon your overall app design.

  • Default Text: The Default Text is the text that is present in the Rich Text Editor by default and can be changed by the user to enter the text that they need to.

How to Use a Rich Text Editor control?

Start with selecting the Rich Text Editor from the Basic section of the Controls Menu.

rich text editor control1

The Rich Text Editor will then appear on the screen in the builder, you can then set all the above properties as per your requirements.

You can use the Data option to bind the data the Rich Text Editor field.

Bind Data

There are different ways in which you can bind data to the Rich Text Editor field.

  1. Static Data: This is the data that does not change over the period of time. Such data is used to assign default values in fields in your application. The static data can be based on the data type i.e. Numeric, Text, and List type data.

  2. Sheets : This allows you to fetch data from a sheet and display it in the fields. Select your sheet from the list and then select the columns to be used. You can also add filters and sort data.

  3. Controls: This allows you to get data from one of the App controls.

  4. Variables: This assigns the value of the variables defined in the app.

  5. LoggedIn User: You can display the properties related to the LoggedIn User like username, usermail, Admin, status and so on. You can select a single property only . Select column and click Save .

  6. API: This allows you to add an API and select the values returned by the respective API. You can select multiple keys to display values in the detail view.

  7. Custom Formula : This can be used to apply formulas and store the output of those formulas in the detail view rows. You can learn more about formulas here.

Preview of Rich Text Editor