Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

CancelEventArgs Class

 

Provides data for a cancelable event.

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

System.Object
  System.EventArgs
    System.ComponentModel.CancelEventArgs
      Microsoft.VisualBasic.ApplicationServices.StartupEventArgs
      System.ComponentModel.DoWorkEventArgs
      System.Configuration.SettingChangingEventArgs
      System.Drawing.Printing.PrintEventArgs
      System.IdentityModel.Services.ErrorEventArgs
      System.IdentityModel.Services.RedirectingToIdentityProviderEventArgs
      System.IdentityModel.Services.SecurityTokenReceivedEventArgs
      System.IdentityModel.Services.SecurityTokenValidatedEventArgs
      System.IdentityModel.Services.SessionSecurityTokenReceivedEventArgs
      System.Web.ModelBinding.ModelValidatingEventArgs
      System.Web.UI.WebControls.DetailsViewDeleteEventArgs
      System.Web.UI.WebControls.DetailsViewInsertEventArgs
      System.Web.UI.WebControls.DetailsViewModeEventArgs
      System.Web.UI.WebControls.DetailsViewPageEventArgs
      System.Web.UI.WebControls.DetailsViewUpdateEventArgs
      System.Web.UI.WebControls.EntityDataSourceChangingEventArgs
      System.Web.UI.WebControls.EntityDataSourceContextDisposingEventArgs
      System.Web.UI.WebControls.EntityDataSourceSelectingEventArgs
      System.Web.UI.WebControls.FormViewDeleteEventArgs
      System.Web.UI.WebControls.FormViewInsertEventArgs
      System.Web.UI.WebControls.FormViewModeEventArgs
      System.Web.UI.WebControls.FormViewPageEventArgs
      System.Web.UI.WebControls.FormViewUpdateEventArgs
      System.Web.UI.WebControls.GridViewCancelEditEventArgs
      System.Web.UI.WebControls.GridViewDeleteEventArgs
      System.Web.UI.WebControls.GridViewEditEventArgs
      System.Web.UI.WebControls.GridViewPageEventArgs
      System.Web.UI.WebControls.GridViewSelectEventArgs
      System.Web.UI.WebControls.GridViewSortEventArgs
      System.Web.UI.WebControls.GridViewUpdateEventArgs
      System.Web.UI.WebControls.LinqDataSourceDeleteEventArgs
      System.Web.UI.WebControls.LinqDataSourceDisposeEventArgs
      System.Web.UI.WebControls.LinqDataSourceInsertEventArgs
      System.Web.UI.WebControls.LinqDataSourceSelectEventArgs
      System.Web.UI.WebControls.LinqDataSourceUpdateEventArgs
      System.Web.UI.WebControls.ListViewCancelEventArgs
      System.Web.UI.WebControls.ListViewDeleteEventArgs
      System.Web.UI.WebControls.ListViewEditEventArgs
      System.Web.UI.WebControls.ListViewInsertEventArgs
      System.Web.UI.WebControls.ListViewSelectEventArgs
      System.Web.UI.WebControls.ListViewSortEventArgs
      System.Web.UI.WebControls.ListViewUpdateEventArgs
      System.Web.UI.WebControls.ObjectDataSourceDisposingEventArgs
      System.Web.UI.WebControls.ObjectDataSourceFilteringEventArgs
      System.Web.UI.WebControls.ObjectDataSourceMethodEventArgs
      System.Web.UI.WebControls.SqlDataSourceCommandEventArgs
      System.Web.UI.WebControls.SqlDataSourceFilteringEventArgs
      System.Web.UI.WebControls.WebParts.WebPartCancelEventArgs
      System.Web.UI.WebControls.WebParts.WebPartConnectionsCancelEventArgs
      System.Web.UI.WebControls.WebParts.WebPartDisplayModeCancelEventArgs
      System.Windows.Controls.InkCanvasSelectionChangingEventArgs
      System.Windows.Controls.InkCanvasSelectionEditingEventArgs
      System.Windows.Controls.InkCanvasStrokeErasingEventArgs
      System.Windows.Forms.BindingCompleteEventArgs
      System.Windows.Forms.ColumnReorderedEventArgs
      System.Windows.Forms.ColumnWidthChangingEventArgs
      System.Windows.Forms.DataGridViewCellCancelEventArgs
      System.Windows.Forms.DataGridViewCellValidatingEventArgs
      System.Windows.Forms.DataGridViewRowCancelEventArgs
      System.Windows.Forms.FormClosingEventArgs
      System.Windows.Forms.InputLanguageChangingEventArgs
      System.Windows.Forms.PopupEventArgs
      System.Windows.Forms.SplitterCancelEventArgs
      System.Windows.Forms.TabControlCancelEventArgs
      System.Windows.Forms.ToolStripDropDownClosingEventArgs
      System.Windows.Forms.TreeViewCancelEventArgs
      System.Windows.Forms.WebBrowserNavigatingEventArgs
      System.Windows.Navigation.NavigatingCancelEventArgs
      System.Windows.SessionEndingCancelEventArgs

[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
public class CancelEventArgs : EventArgs

NameDescription
System_CAPS_pubmethodCancelEventArgs()

Initializes a new instance of the CancelEventArgs class with the Cancel property set to false.

System_CAPS_pubmethodCancelEventArgs(Boolean)

Initializes a new instance of the CancelEventArgs class with the Cancel property set to the given value.

NameDescription
System_CAPS_pubpropertyCancel

Gets or sets a value indicating whether the event should be canceled.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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.

System_CAPS_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).

// Call this method from the constructor of your form
    private void OtherInitialize() {
       this.Closing += new CancelEventHandler(this.Form1_Closing);
       // Exchange commented line and note the difference.
       this.isDataSaved = true;
       //this.isDataSaved = false;
    }

    private void Form1_Closing(Object sender, CancelEventArgs e) {
       if (!isDataSaved) {
          e.Cancel = true;
          MessageBox.Show("You must save first.");
       }
       else {
          e.Cancel = false;
          MessageBox.Show("Goodbye.");
       }
    }

Universal Windows Platform
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 3.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1

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

Return to top
Show:
© 2016 Microsoft