SubDocument.GetText(DocumentRange, PlainTextDocumentExporterOptions) Method

Returns the plain text of the specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

string GetText(
    DocumentRange range,
    PlainTextDocumentExporterOptions options
)

VB.NET

Function GetText(
    range As DocumentRange,
    options As PlainTextDocumentExporterOptions
) As String

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange object, specifying the range in the document for which the plain text representation is obtained.
options	PlainTextDocumentExporterOptions	A PlainTextDocumentExporterOptions instance, containing options for plain text export.

Returns

Type	Description
String	A String value, containing the text of the specified range.

Remarks

Use this method to get a plain text of any part of the document. This method overload triggers export-related events as described in the following table:

Event	Description
RichEditControl.BeforeExport	Does not occur.
RichEditControl.AfterExport	Does not occur.

Note

If you operate with a selection range, the GetText method should be combined with 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.

Example

This code snippet finds the first table of contents which is built upon Heading styles using the TOC field and converts it to plain text, including field codes. The SubDocument.GetText method overload is used for this purpose. It allows you to set the PlainTextDocumentExporterOptions settings to include field codes and specify field enclosing symbols.

Export.cs

document.LoadDocument("SampleTOC.docx", DocumentFormat.OpenXml);
string plainText = String.Empty;

foreach (Field item in document.Fields)
{
    string fieldCode = document.GetText(item.CodeRange);
    string[] fieldParts = fieldCode.Split(' ');
    if (fieldParts[0].Trim() == "TOC" && fieldParts[1].Trim() == "\\h")
    {
        DevExpress.XtraRichEdit.Export.PlainTextDocumentExporterOptions exportOptions =
            new DevExpress.XtraRichEdit.Export.PlainTextDocumentExporterOptions();
        exportOptions.ExportHiddenText = true;
        exportOptions.FieldCodeStartMarker = "[<";
        exportOptions.FieldCodeEndMarker = ">";
        exportOptions.FieldResultEndMarker = "]";
        plainText = document.GetText(item.Range, exportOptions);
    }
}

Export.vb

document.LoadDocument("SampleTOC.docx", DocumentFormat.OpenXml)
Dim plainText As String = String.Empty

For Each item As Field In document.Fields
    Dim fieldCode As String = document.GetText(item.CodeRange)
    Dim fieldParts() As String = fieldCode.Split(" "c)
    If fieldParts(0).Trim() = "TOC" AndAlso fieldParts(1).Trim() = "\h" Then
        Dim exportOptions As New DevExpress.XtraRichEdit.Export.PlainTextDocumentExporterOptions()
        exportOptions.ExportHiddenText = True
        exportOptions.FieldCodeStartMarker = "[<"
        exportOptions.FieldCodeEndMarker = ">"
        exportOptions.FieldResultEndMarker = "]"
        plainText = document.GetText(item.Range, exportOptions)
    End If
Next item

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetText(DocumentRange, PlainTextDocumentExporterOptions) 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-richedit-document-api/CS/RichEditAPISample/CodeExamples/Export.cs#L88

    exportOptions.FieldResultEndMarker = "]";
    plainText = document.GetText(item.Range, exportOptions);
}

VB.NET

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Export.vb#L78

    exportOptions.FieldResultEndMarker = "]"
    plainText = document.GetText(item.Range, exportOptions)
End If