GridViewCancelEditEventArgs Class
Provides data for the RowCancelingEdit event.
System.EventArgs
System.ComponentModel.CancelEventArgs
System.Web.UI.WebControls.GridViewCancelEditEventArgs
Assembly: System.Web (in System.Web.dll)
The GridViewCancelEditEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
|
GridViewCancelEditEventArgs | Initializes a new instance of the GridViewCancelEditEventArgs class. |
| Name | Description | |
|---|---|---|
|
Cancel | Gets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.) |
|
|
RowIndex | Gets the index of the row containing the Cancel button that raised the event. |
| Name | Description | |
|---|---|---|
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
ToString | 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 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" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <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 = ""; } </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>GridView RowCancelingEdit Example</title> </head> <body> <form id="form1" runat="server"> <h3>GridView RowCancelingEdit Example</h3> <asp:label id="Message" forecolor="Red" runat="server"/> <br/> <!-- 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" datasourceid="CustomersSqlDataSource" autogeneratecolumns="true" autogenerateeditbutton="true" allowpaging="true" datakeynames="CustomerID" onrowcancelingedit="CustomersGridView_RowCancelingEdit" onrowediting="CustomersGridView_RowEditing" onrowupdated="CustomersGridView_RowUpdated" runat="server"> </asp:gridview> <!-- 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%>" runat="server"> </asp:sqldatasource> </form> </body> </html>
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
