Updated: August 2008
Occurs when a row's Edit button is clicked, but before the GridView control enters edit mode.
Public Event RowEditing As GridViewEditEventHandler
Dim instance As GridView Dim handler As GridViewEditEventHandler AddHandler instance.RowEditing, handler
public event GridViewEditEventHandler RowEditing
public: event GridViewEditEventHandler^ RowEditing { void add (GridViewEditEventHandler^ value); void remove (GridViewEditEventHandler^ value); }
JScript does not support events.
<asp:GridView OnRowEditing="GridViewEditEventHandler" />
The RowEditing event is raised when a row's Edit button is clicked, but before the GridView control enters edit mode. This enables you to provide an event-handling method that performs a custom routine, such as canceling the edit operation, whenever this event occurs.
A GridViewEditEventArgs object is passed to the event-handling method, which enables you to determine the index of the current row and to indicate that the edit operation should be canceled. To cancel the edit operation, set the Cancel property of the GridViewEditEventArgs object to true.
For more information about handling events, see Consuming Events.
The following example demonstrates how to use the RowEditing event to put a row in edit mode when the data source is set programmatically.
<%@ Page Language="VB" %> <%@ Import Namespace="System.Data" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Protected Sub Page_Load() If Not Page.IsPostBack Then ' Create a new table. Dim taskTable As New DataTable("TaskList") ' Create the columns. taskTable.Columns.Add("Id", GetType(Integer)) taskTable.Columns.Add("Description", GetType(String)) taskTable.Columns.Add("IsComplete", GetType(Boolean)) 'Add data to the new table. For i = 0 To 19 Dim tableRow = taskTable.NewRow() tableRow("Id") = i tableRow("Description") = "Task " + i.ToString() tableRow("IsComplete") = False taskTable.Rows.Add(tableRow) Next 'Persist the table in the Session object. Session("TaskTable") = taskTable 'Bind data to the GridView control. BindData() End If End Sub Protected Sub TaskGridView_PageIndexChanging(ByVal sender As Object, ByVal e As GridViewPageEventArgs) TaskGridView.PageIndex = e.NewPageIndex 'Bind data to the GridView control. BindData() End Sub Protected Sub TaskGridView_RowEditing(ByVal sender As Object, ByVal e As GridViewEditEventArgs) 'Set the edit index. TaskGridView.EditIndex = e.NewEditIndex 'Bind data to the GridView control. BindData() End Sub Protected Sub TaskGridView_RowCancelingEdit() 'Reset the edit index. TaskGridView.EditIndex = -1 'Bind data to the GridView control. BindData() End Sub Protected Sub TaskGridView_RowUpdating(ByVal sender As Object, ByVal e As GridViewUpdateEventArgs) 'Retrieve the table from the session object. Dim dt = CType(Session("TaskTable"), DataTable) 'Update the values. Dim row = TaskGridView.Rows(e.RowIndex) dt.Rows(row.DataItemIndex)("Id") = (CType((row.Cells(1).Controls(0)), TextBox)).Text dt.Rows(row.DataItemIndex)("Description") = (CType((row.Cells(2).Controls(0)), TextBox)).Text dt.Rows(row.DataItemIndex)("IsComplete") = (CType((row.Cells(3).Controls(0)), CheckBox)).Checked 'Reset the edit index. TaskGridView.EditIndex = -1 'Bind data to the GridView control. BindData() End Sub Private Sub BindData() TaskGridView.DataSource = Session("TaskTable") TaskGridView.DataBind() End Sub </script> <html > <head runat="server"> <title>GridView example</title> </head> <body> <form id="form1" runat="server"> <div> <asp:GridView ID="TaskGridView" runat="server" AutoGenerateEditButton="True" AllowPaging="true" OnRowEditing="TaskGridView_RowEditing" OnRowCancelingEdit="TaskGridView_RowCancelingEdit" OnRowUpdating="TaskGridView_RowUpdating" OnPageIndexChanging="TaskGridView_PageIndexChanging"> </asp:GridView> </div> </form> </body> </html>
<%@ Page Language="C#" %> <%@ Import Namespace="System.Data" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> protected void Page_Load(object sender, EventArgs e) { if (!Page.IsPostBack) { // Create a new table. DataTable taskTable = new DataTable("TaskList"); // Create the columns. taskTable.Columns.Add("Id", typeof(int)); taskTable.Columns.Add("Description", typeof(string)); taskTable.Columns.Add("IsComplete", typeof(bool) ); //Add data to the new table. for (int i = 0; i < 20; i++) { DataRow tableRow = taskTable.NewRow(); tableRow["Id"] = i; tableRow["Description"] = "Task " + i.ToString(); tableRow["IsComplete"] = false; taskTable.Rows.Add(tableRow); } //Persist the table in the Session object. Session["TaskTable"] = taskTable; //Bind data to the GridView control. BindData(); } } protected void TaskGridView_PageIndexChanging(object sender, GridViewPageEventArgs e) { TaskGridView.PageIndex = e.NewPageIndex; //Bind data to the GridView control. BindData(); } protected void TaskGridView_RowEditing(object sender, GridViewEditEventArgs e) { //Set the edit index. TaskGridView.EditIndex = e.NewEditIndex; //Bind data to the GridView control. BindData(); } protected void TaskGridView_RowCancelingEdit(object sender, GridViewCancelEditEventArgs e) { //Reset the edit index. TaskGridView.EditIndex = -1; //Bind data to the GridView control. BindData(); } protected void TaskGridView_RowUpdating(object sender, GridViewUpdateEventArgs e) { //Retrieve the table from the session object. DataTable dt = (DataTable)Session["TaskTable"]; //Update the values. GridViewRow row = TaskGridView.Rows[e.RowIndex]; dt.Rows[row.DataItemIndex]["Id"] = ((TextBox)(row.Cells[1].Controls[0])).Text; dt.Rows[row.DataItemIndex]["Description"] = ((TextBox)(row.Cells[2].Controls[0])).Text; dt.Rows[row.DataItemIndex]["IsComplete"] = ((CheckBox)(row.Cells[3].Controls[0])).Checked; //Reset the edit index. TaskGridView.EditIndex = -1; //Bind data to the GridView control. BindData(); } private void BindData() { TaskGridView.DataSource = Session["TaskTable"]; TaskGridView.DataBind(); } </script> <html > <head runat="server"> <title>GridView example</title> </head> <body> <form id="form1" runat="server"> <div> <asp:GridView ID="TaskGridView" runat="server" AutoGenerateEditButton="True" AllowPaging="true" OnRowEditing="TaskGridView_RowEditing" OnRowCancelingEdit="TaskGridView_RowCancelingEdit" OnRowUpdating="TaskGridView_RowUpdating" OnPageIndexChanging="TaskGridView_PageIndexChanging"> </asp:GridView> </div> </form> </body> </html>
The following example demonstrates how to use the RowEditing event to cancel the editing operation if the user attempts to edit the record for a company in the United States.
<%@ Page language="VB" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Sub CustomersGridView_RowEditing(ByVal sender As Object, ByVal e As GridViewEditEventArgs) ' Get the country for the row being edited. For this example, the ' country is contained in the seventh column (index 6). Dim country As String = CustomersGridView.Rows(e.NewEditIndex).Cells(6).Text ' For this example, cancel the edit operation if the user attempts ' to edit the record of a customer from the United States. If country = "USA" Then ' Cancel the edit operation. e.Cancel = True Message.Text = "You cannot edit this record." Else Message.Text = "" End If End Sub </script> <html > <head runat="server"> <title>GridView RowEditing Example</title> </head> <body> <form id="form1" runat="server"> <h3>GridView RowEditing Example</h3> <asp:label id="Message" forecolor="Red" runat="server"/> <br/> <!-- The GridView control automatically sets the columns --> <!-- specified in the datakeynames property 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" onrowediting="CustomersGridView_RowEditing" 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>
<%@ 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_RowEditing(Object sender, GridViewEditEventArgs e) { // Get the country for the row being edited. For this example, the // country is contained in the seventh column (index 6). String country = CustomersGridView.Rows[e.NewEditIndex].Cells[6].Text; // For this example, cancel the edit operation if the user attempts // to edit the record of a customer from the Unites States. if (country == "USA") { // Cancel the edit operation. e.Cancel = true; Message.Text = "You cannot edit this record."; } else { Message.Text = ""; } } </script> <html > <head runat="server"> <title>GridView RowEditing Example</title> </head> <body> <form id="form1" runat="server"> <h3>GridView RowEditing Example</h3> <asp:label id="Message" forecolor="Red" runat="server"/> <br/> <!-- The GridView control automatically sets the columns --> <!-- specified in the datakeynames property 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" onrowediting="CustomersGridView_RowEditing" 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 Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
Date
History
Reason
August 2008
Made changes to the first example.
Customer feedback.
Please note that when the DataSourceID is not used in the definition of the GridView, DataBind must be called again after the GridView is put into edit more. Else, a strange behaviour of having to click the edit button twice can be the result (and empty edit-controls).
At least, this is my experience.
Is there an event fired after the edit button is clicked and after the row enters edit mode? I have a need for this in my current application where I want to enable/disable controls within the row being editted. I can't set the enabled properties in the editting event because the edit template controls have not been created yet.