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.
- 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.
- 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.
- Always: When this condition is selected, the data in the control will be submitted irrespective of the state of the Rich Text Editor field.
- 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.
- 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.
- 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.
- 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.
- Classic (Default)
- Height: The height option lets you define the height of the Rich Text Editor in the micrapp. By default, the height is set to 350 px.
- 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.
The text box 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 F option to bind data to the Rich Text Editor field and the V option to add validations to the field. You can learn more about validations here. There are four ways in which you can bind data to the Rich Text Editor field.
- Static Data: Use this to directly type in the text that you want to display.
- Sheet: This allows you to get data from a sheet and display it in the Rich Text Editor.
- Control: This allows you to bind data to the Rich Text Editor by using another control’s value present in the microapp.
- Formula: This is used to apply formulas and store the output of those formulas in the Rich Text Editor. You can learn more about formulas here.