Field.Range Property

Returns the document range the field occupies.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

DocumentRange Range { get; }

VB.NET

ReadOnly Property Range As DocumentRange

Property Value

Type	Description
DocumentRange	The document range that contains the field (including its code and result).

Remarks

Use the Field.CodeRange property to obtain the field code’s range, and the Field.ResultRange property to retrieve the field result’s range.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Range 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#L48

DocumentPosition fieldPosition = field.Range.Start;
document.Delete(field.Range);
document.InsertRtfText(fieldPosition, fieldResult);

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Export.cs#L88

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

winforms-richedit-table-of-contents-practical-guide/CS/Form1.cs#L93

Field field = Document.Fields.Create(Document.Paragraphs[(insertHeading ? 1 : 0)].Range.Start, "TOC " + switches);
CharacterProperties cp = Document.BeginUpdateCharacters(field.Range);
cp.Bold = false;

VB.NET

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

Dim fieldPosition As DocumentPosition = field.Range.Start
document.Delete(field.Range)
document.InsertRtfText(fieldPosition, fieldResult)

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

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

winforms-richedit-table-of-contents-practical-guide/VB/Form1.vb#L85

Dim field As Field = Document.Fields.Create(Document.Paragraphs(If(insertHeading, 1, 0)).Range.Start, "TOC " & switches)
Dim cp As CharacterProperties = Document.BeginUpdateCharacters(field.Range)
cp.Bold = False