RichEditControl.IsUpdateLocked Property

Returns a value indicating whether the RichEditControl is locked for update.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v18.2.dll

Declaration

C#

[Browsable(false)]
public bool IsUpdateLocked { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property IsUpdateLocked As Boolean

Property Value

Type	Description
Boolean	true, if the control is locked; otherwise, false.

Remarks

Enclose your code in the RichEditControl.BeginUpdate - RichEditControl.EndUpdate method calls to suppress the RichEditControl’s visual updates and improve its performance when you perform multiple changes to a document.

The IsUpdateLocked property allows you to determine the RichEditControl’s state. If it is locked by the RichEditControl.BeginUpdate method, the IsUpdateLocked property returns true.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the IsUpdateLocked property.

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#

how-to-determine-a-ui-command-executed-in-richeditcontrol-in-response-to-a-user-action-t371666/CS/DXApplication9/CustomCommandExecutionListenerService.cs#L29

base.EndCommandExecution(command, state);
if (!RichEditControl.IsUpdateLocked)
{

VB.NET

how-to-determine-a-ui-command-executed-in-richeditcontrol-in-response-to-a-user-action-t371666/VB/DXApplication9/CustomCommandExecutionListenerService.vb#L22

MyBase.EndCommandExecution(command, state)
If Not RichEditControl.IsUpdateLocked Then
    RaiseCommandExecutedEvent(New CommandEventArgs(command.ToString(), command.Description))