SubDocument.GetText(DocumentRange) Method

Returns the plain text of the specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

string GetText(
    DocumentRange range
)

VB.NET

Function GetText(
    range As DocumentRange
) 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.

Returns

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

Remarks

Use the GetText 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	Allows you to specify options for plain text export (defined by the PlainTextDocumentExporterOptions instance).
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 switches to the document footer to select the first paragraph of the footer content.

Subsequently, the SubDocument.GetText method obtains the selection as plain text.

Note that the GetText method is combined with the DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument method pair to ensure that the GetText method uses a correct document model.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Export.vb

document.LoadDocument("FloatingObjects.docx", DocumentFormat.OpenXml)

' Select footer.
Dim footerDocument As SubDocument = document.Sections(0).BeginUpdateFooter()
document.ChangeActiveDocument(footerDocument)
document.Selection = footerDocument.Paragraphs(0).Range
document.Sections(0).EndUpdateFooter(footerDocument)
' Get selection as plain text.
Dim docRange As SubDocument = document.Selection.BeginUpdateDocument()
Dim plainText As String = docRange.GetText(docRange.Range)
document.Selection.EndUpdateDocument(docRange)

DevExpress.XtraEditors.XtraMessageBox.SmartTextWrap = True
DevExpress.XtraEditors.XtraMessageBox.Show(plainText)

Export.cs

document.LoadDocument("FloatingObjects.docx", DocumentFormat.OpenXml);

// Select footer.
SubDocument footerDocument = document.Sections[0].BeginUpdateFooter();
document.ChangeActiveDocument(footerDocument);
document.Selection = footerDocument.Paragraphs[0].Range;
document.Sections[0].EndUpdateFooter(footerDocument);
// Get selection as plain text.
SubDocument docRange = document.Selection.BeginUpdateDocument();
string plainText = docRange.GetText(docRange.Range);
document.Selection.EndUpdateDocument(docRange);

DevExpress.XtraEditors.XtraMessageBox.SmartTextWrap = true;
DevExpress.XtraEditors.XtraMessageBox.Show(plainText);

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetText(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-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/SearchAndReplace.cs#L23

{
    sixLetterWords.Add(document.GetText(r));
}

how-to-integrate-spellchecker-menu-items-into-the-xtrarichedit-context-menu-e1758/CS/RichEditPopupMenu/Form1.cs#L60

DocumentRange range = richEditControl1.Document.CreateRange(wordStart, wordEnd - wordStart);
string word = richEditControl1.Document.GetText(range);
if (spellChecker1.IsMisspelledWord(word, spellChecker1.Culture))

subdocument-essentials-simple-examples-e2265/CS/SubDocumentExample/Form1.cs#L53

SubDocument doc = range.BeginUpdateDocument();
string plainText = doc.GetText(range);
MessageBox.Show(plainText, "Selected Text");

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/SearchAndReplaceActions.cs#L23

{
    sixLetterWords.Add(document.GetText(r));
}

word-document-api-examples/CS/CodeExamples/FieldActions.cs#L33

{
    string fieldCode = document.GetText(document.Fields[i].CodeRange);
    if (fieldCode == "DATE")

VB.NET

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/SearchAndReplace.vb#L17

For Each r As DocumentRange In found
    sixLetterWords.Add(document.GetText(r))
Next r

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/SearchAndReplaceActions.vb#L17

For Each r As DocumentRange In found
    sixLetterWords.Add(document.GetText(r))
Next r

how-to-integrate-spellchecker-menu-items-into-the-xtrarichedit-context-menu-e1758/VB/RichEditPopupMenu/Form1.vb#L62

richEditControl1.Document.CreateRange(wordStart, wordEnd - wordStart)
        Dim word As String = richEditControl1.Document.GetText(range)
        If spellChecker1.IsMisspelledWord(word, spellChecker1.Culture) Then

subdocument-essentials-simple-examples-e2265/VB/SubDocumentExample/Form1.vb#L49

Dim doc As SubDocument = range.BeginUpdateDocument()
Dim plainText As String = doc.GetText(range)
MessageBox.Show(plainText, "Selected Text")

word-document-api-examples/VB/CodeExamples/FieldActions.vb#L28

For i As Integer = 0 To document.Fields.Count - 1
    Dim fieldCode As String = document.GetText(document.Fields(i).CodeRange)
    If fieldCode = "DATE" Then