ReadOnlyFieldCollection.Get(DocumentRange) Method

Gets all fields located in the specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

ReadOnlyFieldCollection Get(
    DocumentRange range
)

VB.NET

Function Get(
    range As DocumentRange
) As ReadOnlyFieldCollection

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange specifying the range in which to search for fields.

Returns

Type	Description
ReadOnlyFieldCollection	A ReadOnlyFieldCollection object specifying the read-only collection of fields.

Remarks

The Get method returns a collection of Field objects contained in the specified range.

The method can be accessed using the RichEditControl.Document.Fields.Get notation.

Note

If you operate with a selection range, the Get 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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Get(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#

snap-convert-snx-to-repx/CS/SnxToRepx/Converter/ParagraphProcessor.cs#L82

//Get all fields in the specified range
ReadOnlyFieldCollection fields = Server.Document.Fields.Get(range);
//Iterate through fields

VB.NET

snap-convert-snx-to-repx/VB/SnxToRepx/Converter/ParagraphProcessor.vb#L82

'Get all fields in the specified range
Dim fields As ReadOnlyFieldCollection = Server.Document.Fields.Get(range)
'Iterate through fields