Cancel Property (NEventArgs)

In This Topic

Raising the Cancel property is used to signify that the event is handled, meaning any default action normally taken by the implementation as a result of the event must not occur. Once the Cancel property has been raised it will remain in effect throughout the remainder of the event's propagation. This property may be used during any stage of event flow.

Syntax

Visual Basic
C#

'Declaration
 
Public Property Cancel As System.Boolean

'Usage
 
Dim instance As NEventArgs
Dim value As System.Boolean
 
instance.Cancel = value
 
value = instance.Cancel

public System.bool Cancel {get; set;}

Remarks

The DOM allows you to raise the Cancel flag for all events, however that does not mean that you can cancel any default operation, since it is up to the implementation to decide whether to honour the Cancel flag or not. Most events defined by Nevron describe the Cancel meaning.

The context in which the event is raised also determines whether the operation can be canceled or not. For example if you handle a property changing event and cancel it, the DOM will normally honour the Cancel flag and abort the property change procedure. However this event handler may be called during a history undo process and the DOM in this case will not honour the Cancel flag.

Requirements

Target Platforms: Windows 11, Windows 10, Windows 7, Windows Server 2019, Windows Server 2016, Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later)

Reference

NEventArgs Class
NEventArgs Members

Send Feedback