.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

SubDocument.GetRtfText(DocumentRange) Method

Gets the formatted string of the text contained in the specified range.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v21.1.Core.dll


string GetRtfText(
    DocumentRange range


Name Type Description
range DocumentRange

A DocumentRange object representing a text range in the document.


Type Description

A string of RTF text.


You can specify export options via the RichEditDocumentExportOptions.Rtf property in the RichEditControl.BeforeExport event handler or use another GetRtfText method overload.

If you operate with a selection range, the GetRtfText method should be enclosed within a DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument method pair. Otherwise, an incorrect document model might be selected, resulting in an exception “Error: specified document position or range belongs to other document or subdocument” being thrown.

To retrieve the section settings, make sure that the range contains the last section’s paragraph. Otherwise, the section settings are reset to the default.

This code snippet illustrates how to export the selected range to the string in RTF format.

if (this.richEditControl.Document.Selection.Length > 0) {
    DevExpress.XtraRichEdit.API.Native.DocumentRange selection = richEditControl.Document.Selection;
    DevExpress.XtraRichEdit.API.Native.SubDocument doc = selection.BeginUpdateDocument();
    rtfText = doc.GetRtfText(selection);
else {
    rtfText = richEditControl.Document.GetRtfText(richEditControl.Document.Range);
See Also