Field.ResultRange Property

Returns the range that contains the field result.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v23.2.Core.dll

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

Declaration

C#

DocumentRange ResultRange { get; }

VB.NET

ReadOnly Property ResultRange As DocumentRange

Property Value

Type	Description
DocumentRange	The document range the field result occupies.

Example

The code sample below checks all field results and inserts “Empty Value!” if the field result is empty:

C#

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
using System.Drawing;

using (var wordProcessor = new RichEditDocumentServer()) {
    Document document = wordProcessor.Document;
    foreach (Field field in document.Fields) {
        string strResult = document.GetText(field.ResultRange);

        if (strResult == "") {
            document.InsertText(field.ResultRange.Start, "Empty Value!");
        }
    }
} 

VB.NET

``Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
Imports System.Drawing

Using wordProcessor = New RichEditDocumentServer()
    Dim document As Document = wordProcessor.Document
    For Each field As Field In document.Fields
        Dim strResult As String = document.GetText(field.ResultRange)

        If strResult = "" Then
            document.InsertText(field.ResultRange.Start, "Empty Value!")
        End If
    Next field
End Using

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ResultRange property.

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#

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-document-api/CS/RichEditAPISample/CodeExamples/Export.cs#L109

options.AllowExtendingDocumentRange = false;
foreach (Paragraph par in document.Paragraphs.Get(item.ResultRange)) {
    plainText += document.GetText(par.Range, options);

VB.NET

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-document-api/VB/RichEditAPISample/CodeExamples/Export.vb#L97

options.AllowExtendingDocumentRange = False
For Each par As DevExpress.XtraRichEdit.API.Native.Paragraph In document.Paragraphs.[Get](item.ResultRange)
    plainText += document.GetText(par.Range, options)