GridViewDeleteEventHandler Delegate
Represents the method that handles the RowDeleting event of a GridView control.
Assembly: System.Web (in System.Web.dll)
Public Delegate Sub GridViewDeleteEventHandler ( sender As Object, e As GridViewDeleteEventArgs )
Parameters
- sender
-
Type:
System.Object
The source of the event.
- e
-
Type:
System.Web.UI.WebControls.GridViewDeleteEventArgs
A GridViewDeleteEventArgs object that contains the event data.
The GridView control raises the RowDeleting event when a Delete button (a button with its CommandName property set to "Delete") is clicked, but before the GridView control deletes the record. This allows you to provide an event-handling method that performs a custom routine, such as canceling the delete operation, whenever this event occurs.
When you create a GridViewDeleteEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see NIB: Events and Delegates.
The following example demonstrates how to programmatically add a GridViewDeleteEventHandler delegate to the RowDeleting event of a GridView control.
<%@ 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 Page_Load(ByVal sender As Object, ByVal e As EventArgs) ' Create a new GridView control. Dim customersGridView As New GridView() ' Set the GridView control's properties. customersGridView.ID = "CustomersGridView" customersGridView.DataSourceID = "CustomersSqlDataSource" customersGridView.AutoGenerateColumns = True customersGridView.AutoGenerateDeleteButton = True Dim keyArray() As String = {"CustomerID"} customersGridView.DataKeyNames = keyArray ' Programmatically register the event-handling methods. AddHandler customersGridView.RowDeleting, AddressOf CustomersGridView_RowDeleting ' Add the GridView object to the Controls collection ' of the PlaceHolder control. GridViewPlaceHolder.Controls.Add(customersGridView) End Sub Sub CustomersGridView_RowDeleting(ByVal sender As Object, ByVal e As GridViewDeleteEventArgs) ' User the sender parameter to retrieve the GridView control ' that raised the event. Dim customersGridView As GridView = CType(sender, GridView) ' Cancel the delete operation if the user attempts to remove ' the last record from the GridView control. If customersGridView.Rows.Count <= 1 Then e.Cancel = True Message.Text = "You must keep at least one record." End If End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>GridViewDeleteEventHandler Example</title> </head> <body> <form id="form1" runat="server"> <h3>GridViewDeleteEventHandler Example</h3> <asp:label id="Message" forecolor="Red" runat="server"/> <br/> <asp:placeholder id="GridViewPlaceHolder" runat="server"/> <!-- 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]" deletecommand="Delete from Customers where CustomerID = @CustomerID" connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" runat="server"> </asp:sqldatasource> </form> </body> </html>
The following example demonstrates how to declaratively add a GridViewDeleteEventHandler delegate to the RowDeleting event of a GridView control.
<%@ 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"> Private Sub CustomersGridView_RowDeleting _ (ByVal sender As [Object], _ ByVal e As GridViewDeleteEventArgs) Dim cell As TableCell cell = CustomersGridView.Rows(e.RowIndex).Cells(2) If cell.Text = "Beaver" Then e.Cancel = True Message.Text = "You cannot delete customer Beaver." Else Message.Text = "" End If End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml"> <head id="Head1" runat="server"> <title>GridView RowDeleting Example</title> </head> <body> <form id="form1" runat="server"> <h3> GridView RowDeleting Example </h3> <asp:Label ID="Message" ForeColor="Red" runat="server" /> <br /> <asp:GridView ID="CustomersGridView" runat="server" DataSourceID="CustomersSqlDataSource" AutoGenerateColumns="False" AutoGenerateDeleteButton="True" OnRowDeleting="CustomersGridView_RowDeleting" DataKeyNames="CustomerID,AddressID"> <Columns> <asp:BoundField DataField="FirstName" HeaderText="FirstName" SortExpression="FirstName" /> <asp:BoundField DataField="LastName" HeaderText="LastName" SortExpression="LastName" /> <asp:BoundField DataField="City" HeaderText="City" SortExpression="City" /> <asp:BoundField DataField="StateProvince" HeaderText="State" SortExpression="StateProvince" /> </Columns> </asp:GridView> <asp:SqlDataSource ID="CustomersSqlDataSource" runat="server" SelectCommand="SELECT SalesLT.CustomerAddress.CustomerID, SalesLT.CustomerAddress.AddressID, SalesLT.Customer.FirstName, SalesLT.Customer.LastName, SalesLT.Address.City, SalesLT.Address.StateProvince FROM SalesLT.Customer INNER JOIN SalesLT.CustomerAddress ON SalesLT.Customer.CustomerID = SalesLT.CustomerAddress.CustomerID INNER JOIN SalesLT.Address ON SalesLT.CustomerAddress.AddressID = SalesLT.Address.AddressID" DeleteCommand="Delete from SalesLT.CustomerAddress where CustomerID = @CustomerID and AddressID = @AddressID" ConnectionString="<%$ ConnectionStrings:AdventureWorksLTConnectionString %>"> <DeleteParameters> <asp:Parameter Name="AddressID" /> <asp:Parameter Name="CustomerID" /> </DeleteParameters> </asp:SqlDataSource> </form> </body> </html>
Available since 2.0