DocumentRangeExtensions.GetAsFrozen(IEnumerable<DocumentRange>) Method

Makes multiple DocumentRange objects uneditable.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

public static IEnumerable<DocumentRange> GetAsFrozen(
    this IEnumerable<DocumentRange> ranges
)

VB.NET

<ExtensionAttribute>
Public Shared Function GetAsFrozen(
    ranges As IEnumerable(Of DocumentRange)
) As IEnumerable(Of DocumentRange)

Parameters

Name	Type	Description
ranges	IEnumerable<DocumentRange>	The list of target document ranges.

Returns

Type	Description
IEnumerable<DocumentRange>	The list of frozen document ranges.

Remarks

Use the GetAsFrozen method to improve performance when it is necessary to retrieve information from many document ranges, i.e., syntax highlighting.

After this method is called, RichEditControl or RichEditDocumentServer stops tracking the actual document position for these ranges.

Important

After the DocumentRange.GetAsFrozen method is executed, the target ranges cannot be modified. The frozen document ranges become invalid after the document is modified. Don’t use these ranges for further document processing operations.