GridViewCancelEditEventArgs Class
Collapse the table of content
Expand the table of content

GridViewCancelEditEventArgs Class


Provides data for the RowCancelingEdit event.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)


public class GridViewCancelEditEventArgs : CancelEventArgs


Initializes a new instance of the GridViewCancelEditEventArgs class.


Gets or sets a value indicating whether the event should be canceled.(Inherited from CancelEventArgs.)


Gets the index of the row containing the Cancel button that raised the event.


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


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


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


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


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


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

The GridView control raises the RowCancelingEdit event when the Cancel button (a button with its CommandName property set to "Cancel") is clicked, but before exiting edit mode. This allows you to provide an event-handling method that performs a custom routine, such as stopping the cancel operation if it would put the row in an undesired state, whenever this event occurs.

A GridViewCancelEditEventArgs object is passed to the event-handling method, which allows you to determine the index of the row containing the Cancel button that raised the event and to indicate that the cancel operation should be stopped. To stop the cancel operation, set the Cancel property to true.

For more information about handling events, see NIB: Consuming Events.

For a list of initial property values for an instance of GridViewCancelEditEventArgs, see the GridViewCancelEditEventArgs constructor.

The following example demonstrates how to use the GridViewCancelEditEventArgs object passed to the event-handling method to determine the index of the row containing the Cancel button clicked by the user.

<%@ Page language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">

  void CustomersGridView_RowCancelingEdit(Object sender, GridViewCancelEditEventArgs e)

    // Retrieve the row that raised the event from the Rows
    // collection of the GridView control.
    GridViewRow row = CustomersGridView.Rows[e.RowIndex];

    // The update operation was canceled. Display the 
    // primary key of the row. In this example, the primary
    // key is displayed in the second column of the GridView
    // control. To access the text of the column, use the Cells
    // collection of the row.
    Message.Text = "Update for item " + row.Cells[1].Text + " Canceled."; 


  void CustomersGridView_RowEditing(Object sender, GridViewEditEventArgs e)

    // The GridView control is entering edit mode. Clear the message label.
    Message.Text = "";


  void CustomersGridView_RowUpdated(Object sender, GridViewUpdatedEventArgs e)

    // The update operation was successful. Clear the message label.
    Message.Text = "";



<html xmlns="" >
  <head runat="server">
    <title>GridView RowCancelingEdit Example</title>
    <form id="form1" runat="server">

      <h3>GridView RowCancelingEdit Example</h3>

      <asp:label id="Message"


      <!-- The GridView control automatically sets the columns     -->
      <!-- specified in the datakeynames attribute as read-only.   -->
      <!-- No input controls are rendered for these columns in     -->
      <!-- edit mode.                                              -->
      <asp:gridview id="CustomersGridView" 

      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSqlDataSource"  
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        updatecommand="Update Customers SET CompanyName=@CompanyName, Address=@Address, City=@City, PostalCode=@PostalCode, Country=@Country WHERE (CustomerID = @CustomerID)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"


.NET Framework
Available since 2.0

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
© 2015 Microsoft