Skip to main content

IdxRichEditDocument.RtfText Property

Specifies document content (as an RTF string).

Declaration

property RtfText: string read; write;

Property Value

Type Description
string

Document content (as an RTF string).

Remarks

You can use the RtfText property to import/export document content in the RTF format (ensure that support for the Rich Text Format (RTF) is enabled).

Internal Document Model and Import/Export Operations

Important

TdxRichEditControl and TdxRichEditDocumentServer components do not work natively with documents in the DOC format. Instead, these components build a document model in memory using an internal XML-like format. You can use the IdxRichEditDocument interface to edit the current document directly.

The RtfText property value’s read/write operations import/export document content. You can use the following properties to configure RTF import/export settings:

Options.Export.Rtf
Provides access to settings applied to exporting a document to the RTF file format.
Options.Import.Rtf
Provides access to settings applied to importing rich text (RTF) documents into the Rich Edit control.

Import/Export Format Support

DevExpress Rich Text components initially support a limited number of document formats to avoid excessive dependencies:

TdxRichEditControl
Has predefined support only for TXT and RTF.
TdxRichEditDocumentServer
Has predefined support only for TXT.

To enable support for all available formats, add all required dependencies at design time or in code:

Extension Document Format Format Value Import/Export Settings Support / Required Dependencies
TXT/txt Plain Text PlainText Options.Import.PlainText/Options.Export.PlainText Built-in Support
RTF/rtf Rich Text Format Rtf Options.Import.Rtf/Options.Export.Rtf dxRichEdit.Rtf (add only for TdxRichEditDocumentServer)
DOC/doc Microsoft Word® 97 – 2003 Doc Options.Import.Doc/Options.Export.Doc dxRichEdit.Doc
HTML/html Hypertext Markup Language Html Options.Import.Html/Options.Export.Html dxRichEdit.Html
DOCX/docx Office OpenXML OpenXml Options.Import.OpenXml/Options.Export.OpenXml dxRichEdit.OpenXML

At design time, you can right-click a TdxRichEditControl or TdxRichEditDocumentServer component, expand the Add Unit to Support menu item, and add all required dependencies.

VCL Rich Edit Control: Add Supported Document Formats at Design Time

Other Document Import/Export Options

You can also use the following API members to import/export document content in different supported[1] formats:

DocBytes
Specifies document content as a byte array (in the Microsoft Word® 97 – 2003 binary format).
OpenXmlBytes
Specifies document content as a byte array (in the Office OpenXML format).
Text
Specifies document content (as a plain text string).
LoadDocument | SaveDocument
Export/import document content to/from a file or stream in any supported format.
Footnotes
  1. Ensure that support for all required document formats is enabled; otherwise, an exception occurs.
    Refer to corresponding API member descriptions for detailed information on support for different document formats.

See Also