RichText | X4Documentation

<RichText> controls are used to provide users of a web application with a WYSIWYG interface for editing HTML content.

<RichText> controls can be used in all available layout types:

BoxLayout
FlowLayout
GridLayout
ResponsiveLayout
TabLayout

In addition to the standard attributes listed under Controls, the following attributes can be defined for a <RichText> control:

Attribute	Description
`displayName`	Content to be edited using the rich text editing controls. The value you specify in the `displayName` attribute is displayed only if the `value` attribute is empty. Data binding possible Possible values: any string
`readonly`	Specifies whether the rich text editing controls are displayed in the Web application. Data binding (Boolean) is possible Possible values: `true`: The rich text editing controls are not displayed. `false` (default) Rich text editing controls are displayed and can be opened with a click of the mouse.
`value`	Content to be edited with the rich text controls. This attribute is mandatory but does not need to contain a value. If you do not specify a `value` or a value for `displayName`, the Web app displays a blank area for which you can click to display the rich text editing controls. Data binding possible Possible values: any string

Attribute

Description

displayName

Content to be edited using the rich text editing controls.

The value you specify in the displayName attribute is displayed only if the value attribute is empty.

Data binding possible

Possible values: any string

readonly

Specifies whether the rich text editing controls are displayed in the Web application.

Data binding (Boolean) is possible

Possible values:

true: The rich text editing controls are not displayed.
false (default) Rich text editing controls are displayed and can be opened with a click of the mouse.

value

Content to be edited with the rich text controls.

This attribute is mandatory but does not need to contain a value.

If you do not specify a value or a value for displayName, the Web app displays a blank area for which you can click to display the rich text editing controls.

Data binding possible

Possible values: any string

The following rich text editing controls are displayed:

Export rich text content as PDF

If you add the <PDFExport> element within the <RichText> control, the button is also displayed. Use this button to download the contents as a PDF file.