Export (0) Print
Expand All

DetailsViewDeletedEventArgs Class

Note: This class is new in the .NET Framework version 2.0.

Provides data for the ItemDeleted event.

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

public class DetailsViewDeletedEventArgs : EventArgs
public class DetailsViewDeletedEventArgs extends EventArgs
public class DetailsViewDeletedEventArgs extends EventArgs

The DetailsView control raises the ItemDeleted event when a Delete button (a button with its CommandName property set to "Delete") within the control is clicked, but after the DetailsView control deletes the record. This allows you to provide an event handler that performs a custom routine, such as checking the results of a delete operation, whenever this event occurs.

A DetailsViewDeletedEventArgs object is passed to the event handler, which allows you to determine the number of records affected and any exceptions that might have occurred. To determine the number of records affected by the delete operation, use the AffectedRows property. Use the Exception property to determine whether any exceptions occurred. You can also indicate whether the exception was handled in the event handler by setting the ExceptionHandled property. If you want to access the name/value pairs of the key fields and non-key fields of the deleted record, use the Keys and Values properties, respectively.

For more information about handling events, see Consuming Events.

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

The following code example demonstrates how to use the DetailsViewDeletedEventArgs object passed to the event handler for the ItemDeleted event to determine whether an exception occurred during a delete operation.


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

<script runat="server">

  void StoresDetailView_ItemDeleted(Object sender, 
    DetailsViewDeletedEventArgs e)
  {
    // Use the Exception property to determine whether an exception
    // occurred during the delete operation.
    if (e.Exception == null)
    {
      // Use the AffectedRows property to determine the numbers of
      // rows affected by the delete operation.
      if (e.AffectedRows == 1)
      {
        MessageLabel.Text = e.AffectedRows.ToString() 
          + " record deleted successfully.";
      }
      else
      {
        MessageLabel.Text = e.AffectedRows.ToString() 
          + " records deleted successfully.";
      }
    }
    else
    {
      // Insert the code to handle the exception.
      MessageLabel.Text = e.Exception.Message;
      
      // Use the ExceptionHandled property to indicate that the 
      // exception is already handled.
      e.ExceptionHandled = true;
    }
  }

</script>

<html>
  <body>
    <form runat="server">
        
      <h3>DetailsViewDeletedEventArgs Example</h3>
                
        <asp:detailsview id="CustomerDetailsView"
          datasourceid="DetailsViewSource"
          datakeynames="CustomerID"
          autogeneratedeletebutton="true"  
          autogeneraterows="true"
          allowpaging="true"
          onitemdeleted="StoresDetailView_ItemDeleted" 
          runat="server">
               
          <fieldheaderstyle backcolor="Navy"
            forecolor="White"/>
                    
        </asp:detailsview>
        
        <asp:label id="MessageLabel"
          forecolor="Red"
          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="DetailsViewSource"
          selectcommand="Select [CustomerID], [CompanyName], [Address], 
            [City], [PostalCode], [Country] From [Customers]"
          deletecommand="Delete [Customers] 
            Where [CustomerID]=@CustomerID"
          connectionstring=
            "<%$ ConnectionStrings:NorthWindConnectionString%>" 
          runat="server"/>
            
      </form>
  </body>
</html>


System.Object
   System.EventArgs
    System.Web.UI.WebControls.DetailsViewDeletedEventArgs

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

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft