Back to Devexpress

DocumentRangeExtensions.GetAsFrozen(DocumentRange) Method

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-documentrangeextensions-dot-getasfrozen-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-documentrange-x29.md

latest2.3 KB
Original Source

DocumentRangeExtensions.GetAsFrozen(DocumentRange) Method

Makes the DocumentRange object uneditable.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
public static DocumentRange GetAsFrozen(
    this DocumentRange range
)
vb
<ExtensionAttribute>
Public Shared Function GetAsFrozen(
    range As DocumentRange
) As DocumentRange

Parameters

NameTypeDescription
rangeDocumentRange

The target document range.

|

Returns

TypeDescription
DocumentRange

The frozen document range.

|

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 this range.

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.

See Also

DocumentRangeExtensions Class

DocumentRangeExtensions Members

DevExpress.XtraRichEdit.API.Native Namespace