SubDocument.GetRtfText(DocumentRange) Method

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

string GetRtfText(
    DocumentRange range
)

VB.NET

Function GetRtfText(
    range As DocumentRange
) As String

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange object representing a text range in the document.

Returns

Type	Description
String	A string of RTF text.

Remarks

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.

View Example

Form1.cs

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);
    selection.EndUpdateDocument(doc);
}
else {
    rtfText = richEditControl.Document.GetRtfText(richEditControl.Document.Range);
}

Form1.vb

If Me.richEditControl.Document.Selection.Length > 0 Then
    Dim selection As DevExpress.XtraRichEdit.API.Native.DocumentRange = richEditControl.Document.Selection
    Dim doc As DevExpress.XtraRichEdit.API.Native.SubDocument = selection.BeginUpdateDocument()
    rtfText = doc.GetRtfText(selection)
    selection.EndUpdateDocument(doc)
Else
    rtfText = richEditControl.Document.GetRtfText(richEditControl.Document.Range)
End If

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetRtfText(DocumentRange) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-reporting-xrrichtext-insert-a-page-break-from-rtf-contents/CS/WindowsFormsApplication1/Form1.cs#L28

DocumentRange tmpRange = server.Document.CreateRange(dp, dr.Start.ToInt() - dp.ToInt());
collection.Add(new MyRtfObject() { RtfSplitContent = server.Document.GetRtfText(tmpRange) });
dp = dr.End;

winforms-richedit-save-text-from-a-range-in-different-formats/CS/GetTextMethodsExample/Form1.cs#L148

DevExpress.XtraRichEdit.API.Native.SubDocument doc = selection.BeginUpdateDocument();
rtfText = doc.GetRtfText(selection);
selection.EndUpdateDocument(doc);

how-to-replace-document-fields-with-their-values/CS/Form1.cs#L46

Field field = fields[i];
string fieldResult = document.GetRtfText(field.ResultRange);
DocumentPosition fieldPosition = field.Range.Start;

winforms-richedit-copy-a-table-to-the-clipboard-in-the-unicode-text-format/CS/CustomCopySelectionCommand.cs#L32

data.SetData(OfficeDataFormats.UnicodeText, plainText);
data.SetData(OfficeDataFormats.Rtf, richEditControl.Document.GetRtfText(range));
Clipboard.Clear();

how-to-customize-copy-and-paste-commands/CS/RichEditCustomCopyPaste/CustomCommands.cs#L33

DataObject data = new DataObject();
data.SetData(OfficeDataFormats.Rtf, richEditControl.Document.GetRtfText(richEditControl.Document.Selection));
data.SetData(OfficeDataFormats.UnicodeText, richEditControl.Document.GetText(richEditControl.Document.Selection));

VB.NET

winforms-reporting-xrrichtext-insert-a-page-break-from-rtf-contents/VB/WindowsFormsApplication1/Form1.vb#L27

Dim tmpRange As DocumentRange = server.Document.CreateRange(dp, dr.Start.ToInt() - dp.ToInt())
collection.Add(New MyRtfObject() With {.RtfSplitContent = server.Document.GetRtfText(tmpRange)})
dp = dr.End

winforms-richedit-save-text-from-a-range-in-different-formats/VB/GetTextMethodsExample/Form1.vb#L113

Dim doc As DevExpress.XtraRichEdit.API.Native.SubDocument = selection.BeginUpdateDocument()
rtfText = doc.GetRtfText(selection)
selection.EndUpdateDocument(doc)

how-to-replace-document-fields-with-their-values/VB/Form1.vb#L45

Dim field As Field = fields(i)
Dim fieldResult As String = document.GetRtfText(field.ResultRange)
Dim fieldPosition As DocumentPosition = field.Range.Start

winforms-richedit-copy-a-table-to-the-clipboard-in-the-unicode-text-format/VB/CustomCopySelectionCommand.vb#L34

data.SetData(OfficeDataFormats.UnicodeText, plainText)
data.SetData(OfficeDataFormats.Rtf, richEditControl.Document.GetRtfText(range))
Clipboard.Clear()

how-to-customize-copy-and-paste-commands/VB/CustomCommands.vb#L34

Dim data As New DataObject()
data.SetData(OfficeDataFormats.Rtf, richEditControl.Document.GetRtfText(richEditControl.Document.Selection))
data.SetData(OfficeDataFormats.UnicodeText, richEditControl.Document.GetText(richEditControl.Document.Selection))