Back to Devexpress

ReadOnlyFieldCollection.Get(DocumentRange) Method

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-readonlyfieldcollection-dot-get-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-documentrange-x29.md

latest2.6 KB
Original Source

ReadOnlyFieldCollection.Get(DocumentRange) Method

Gets all fields located in the specified document range.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
ReadOnlyFieldCollection Get(
    DocumentRange range
)
vb
Function Get(
    range As DocumentRange
) As ReadOnlyFieldCollection

Parameters

NameTypeDescription
rangeDocumentRange

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

|

Returns

TypeDescription
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.

See Also

ReadOnlyFieldCollection Interface

ReadOnlyFieldCollection Members

DevExpress.XtraRichEdit.API.Native Namespace