.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

DocumentRangeExtensions.GetAsFrozen(DocumentRange) Method

Makes the DocumentRange object uneditable.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

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

Parameters

Name Type Description
range DocumentRange

The target document range.

Parameters

Name Type Description
range DocumentRange

The target document range.

Parameters

Name Type Description
range DocumentRange

The target document range.

Returns

Type Description
DocumentRange

The frozen document range.

Returns

Type Description
DocumentRange

The frozen document range.

Returns

Type Description
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