CancelEventHandler Delegate (System.ComponentModel)

.NET Framework Class Library

CancelEventHandler Delegate

Represents the method that handles a cancelable event.

Namespace: System.ComponentModel
Assembly: System (in System.dll)

Syntax

Visual Basic (Declaration)

<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState := True)> _
Public Delegate Sub CancelEventHandler ( _
    sender As Object, _
    e As CancelEventArgs _
)

Visual Basic (Usage)

Dim instance As New CancelEventHandler(AddressOf HandlerMethod)

[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public delegate void CancelEventHandler(
    Object sender,
    CancelEventArgs e
)

Visual C++

[HostProtectionAttribute(SecurityAction::LinkDemand, SharedState = true)]
public delegate void CancelEventHandler(
    Object^ sender, 
    CancelEventArgs^ e
)

JScript

JScript does not support delegates.

Parameters

sender: Type: System..::.Object
The source of the event.

e: Type: System.ComponentModel..::.CancelEventArgs
A CancelEventArgs that contains the event data.

Remarks

Note:
The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Note:

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

When you create a CancelEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event-handler method is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see Events and Delegates.

Examples

For an example of how to use the CancelEventHandler delegate, please see the sample code in the CancelEventArgs class.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

System.ComponentModel Namespace

CancelEventArgs