Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Work Tasks

Rich Text

  • Last UpdatedJun 25, 2024
  • 5 minute read

Use Rich Text control to enter and view rich text data in your form. You can style the text, align the paragraphs, increase or decrease indentation, insert hyperlinks, images, and tables. To access the inserted hyperlink, press the Control key, and then click on the hyperlink text.

Properties

The properties for the control are grouped under the following tabs:

Basic

Property

Description

Name

Name that identifies the control. This value is also used for the label of the control.

XML Node

XML node mapped to the control. Use this value to map a list to a form and a form to a workflow.

  • Prefix with @ to use the value of the control as an attribute with the immediate parent node. For example, @FirstName.

  • Use / for a parent-child node configuration to uniquely identify a control in a form with multiple containers. For example, Employee/FirstName.

    The default value is the value for the Name property without the spaces.

Note:

- If you use / to denote a parent which is not a container and the parent is at the same level as that of the child, then the XML node for the control is not generated.

- If you edit this value later, then it might affect the mapping between forms, lists, and workflows.

Description

Description for the control.

Appearance

Property

Description

Show Toolbar

Show or hide the toolbar.

  • Select Yes to show the toolbar.

  • Select No to hide the toolbar.

    The default value is Yes.

Visible

Show or hide the control.

  • Select Yes to show the control.

  • Select No to hide the control.

    The default value is Yes.

Read - Only

Allow or deny a user to enter a value for the control.

  • Select Yes to deny a user to enter a value for the control.

  • Select No to allow a user to enter a value for the control.

  • The default value is No.

Note: If the value is Yes, then the toolbar will not be visible, irrespective of the value of the Show Toolbar property.

Label Position

Position of the label for the control.

  • Select Default to allow the system to align the label. The system aligns the label to the left of the control or as specified by the container control.

  • Select Left to align the label to the left of the control.

  • Select Top to align the label to the top of the control.

  • Select Right to align the label to the right of the control.

  • Select Bottom to align the label to the bottom of the control.

  • Select Suppress to hide the label for the control.

    The default value is Default.

Note:
-If the value is Default and the control is placed on a container control, then the value of the Label Position property of the container control determines the position of the label for the control.

- For example, if the value is Default and the control is placed on a Base Form with Label Position property set to Top, then the label is aligned to the top of the control.

Label-Control Area

Area occupied by the label and the control in percentage.

  • Select Default to allow the system to set the label and the control areas.

  • Select Custom to specify the label area. The control area is automatically set based on the label area.

    The default value is Default.

Note:
- If the value is Default and the control is placed on a container control, then the value of the Label-Control Area property of the container control determines the area of the label for the control.

- This is applicable only when the Label Position is set to Left or Right.

Width

Width in pixels for the control.

The default value is 100%.

The recommended value is 200px.

Note: If the value is 0, then the width of the control is set as per the default values.

Height

Height in pixels for the control.

The default value is 250 px.

Note:
-If the value is 0, then the height of the control is set as per the default values.
- In iOS devices, the height of the Rich Text control automatically resizes to fit contents. You cannot customize the height nor can you set the height to the default value.

Retain Space

Reserve or remove space when the control is hidden.

  • Select Yes to keep space when the control is hidden.

  • Select No to remove space when the control is hidden.

    The default value is No.

Validation

Property

Description

Mandatory

Enforce or bypass entering a value for the control.

  • Select Yes to enforce entering a value for the control.

  • Select No to bypass entering a value for the control.

    The default value is No.

Advanced

Property

Description

Id

Reference identification code for the control. This value is automatically generated and cannot be changed.

Include in Summary

Allow or deny a user to view the value in the Summary of a Base Form.

  • Select Yes to allow a user to view the value in the Summary of a Base Form.

  • Select No to deny a user to view the value in the Summary of a Base Form.

    The default value is No.

Note:
- This property is applicable only when the control is used on a Base Form with Repeating property set to True, and the form is viewed on a small form factor mobile device.

- For information about Summary of a Base Form, see Base Form.

-When the control is used in a Base Form, the formatting applied to the text is not reflected in the summary. The text appears as plain text.

Toolbar Options

Select the type of toolbar based on the toolbar styles and commands displayed.

  • Select Standard to display the standard toolbar styles and commands.

  • Select Advanced to display all the toolbar styles and commands.

    The default type is Standard.

Note: In an iOS device, to use the Advanced toolbar in the Rich Text control outside any of the Container controls, make sure the height and width is set to values higher than the default values.

Note:
- Entering or editing values in the Rich Text control is not supported in the Mozilla Firefox browser.
- When you select a color from the color picker, make sure the form window is large enough to display the color picker completely to be able to select the text color and background color. If the window is small and the color picker is not displayed completely, you might not be able to select a color.
- Toolbar is not supported in devices.
- Rich Text control has the following limitations in iOS devices:
- You cannot open Hyperlinks present in the Rich Text control.
- The height of the Rich Text control automatically resizes to fit contents. You can neither customize the height nor can you set the height to the default value.
- When you set the width of the Rich Text control to the default value, the right hand side border is not displayed. Also, when you switch from landscape mode to portrait mode or vice versa, the text you type goes beyond the border of the control.
- Images take time to load.

Scripts

For information about using scripts, see scripting guidelines for Rich Text control.

Related Links
TitleResults for “How to create a CRG?”Also Available in