SubDocument.GetRtfText(DocumentRange, RtfDocumentExporterOptions) Method
Gets the formatted string of the text contained in the specified range.
Namespace: DevExpress.XtraRichEdit.API.Native
Assembly: DevExpress.RichEdit.v24.2.Core.dll
NuGet Package: DevExpress.RichEdit.Core
#Declaration
string GetRtfText(
DocumentRange range,
RtfDocumentExporterOptions options
)
#Parameters
Name | Type | Description |
---|---|---|
range | Document |
A Document |
options | Rtf |
An Rtf |
#Returns
Type | Description |
---|---|
String | A string of RTF text. |
#Remarks
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 section’s last paragraph. Otherwise, the section settings are reset to the default.
#Example
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);
selection.EndUpdateDocument(doc);
}
else {
rtfText = richEditControl.Document.GetRtfText(richEditControl.Document.Range);
}