Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

CancelEventArgs Class

Provides data for a cancelable event.

System.Object
  System.EventArgs
    System.ComponentModel.CancelEventArgs

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

type CancelEventArgs =  
    class 
        inherit EventArgs 
    end

The CancelEventArgs type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryCancelEventArgs()Initializes a new instance of the CancelEventArgs class with the Cancel property set to false.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryCancelEventArgs(Boolean)Initializes a new instance of the CancelEventArgs class with the Cancel property set to the given value.
Top

  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryCancelGets or sets a value indicating whether the event should be canceled.
Top

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Top

A cancelable event is raised by a component when it is about to perform an action that can be canceled, such as the Closing event of a Form.

NoteNote

The Closing event is deprecated and has been replaced by FormClosing. It is offered as an example here only to illustrate the usage of CancelEventArgs.

CancelEventArgs provides the Cancel property to indicate whether the event should be canceled.

The following example uses CancelEventArgs and a CancelEventHandler to handle the Closing event of a Form. This code assumes that you have created a Form with a class-level Boolean variable named isDataSaved. It also assumes that you have added a statement to invoke the OtherInitialize method from the form's Load method or the constructor (after the call to InitializeComponent).

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

XNA Framework

Supported in: 3.0, 2.0, 1.0

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2015 Microsoft