GridViewDeleteEventArgs.Values Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a dictionary of the non-key field name/value pairs for the row to delete.

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

public IOrderedDictionary Values { get; }

Property Value

Type: System.Collections.Specialized.IOrderedDictionary

A System.Collections.Specialized.IOrderedDictionary object that contains the non-key field name/value pairs of the row to delete.

The Values property is automatically populated with the name/value pairs of the non-key fields for the row. To determine the field name of an entry, use the DictionaryEntry.Key property of a System.Collections.DictionaryEntry object in the Values dictionary. To determine the value of an entry, use the DictionaryEntry.Value property.

System_CAPS_noteNote

The primary key field or fields are not included in this dictionary. To access the values of the primary key field or fields, use the Keys property.

The following example shows how to use the Values property to get the values of the non-key fields for the row to delete. The values are then written to a log file of deleted records.


<%@ Page language="C#" %>
<%@ import namespace="System.IO" %>

<!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_RowDeleting(Object sender, GridViewDeleteEventArgs e)
  {

    // Record the delete operation in a log file.

    // Create the log text. 
    String logText = "";

    // Append the values of the key fields to the log text.
    foreach (DictionaryEntry keyEntry in e.Keys)
    {
      logText += keyEntry.Key + "=" + keyEntry.Value + ";";
    }

    // Append the values of the non-key fields to the log text.
    foreach (DictionaryEntry valueEntry in e.Values)
    {
      logText += valueEntry.Key + "=" + valueEntry.Value + ";";
    }

    // Display the log content.
    LogTextLabel.Text = logText;

    // Append the text to a log file.
    try
    {
      StreamWriter sw;
      sw = File.AppendText(Server.MapPath(null) + "\\deletelog.txt");
      sw.WriteLine(logText);
      sw.Flush();
      sw.Close();
    }
    catch(UnauthorizedAccessException ex)
    {
      // You must provide read/write access to the file using ACLs.
      LogErrorLabel.Text = "You do not have permission to write to the log.";
    }

  }

  void CustomersGridView_RowDeleted(Object sender, GridViewDeletedEventArgs e)
  {

    if (e.Exception == null)
    {
      // The delete operation succeeded. Clear the message label.
      Message.Text = "";
    }
    else
    {
      // The delete operation failed. Display an error message.
      Message.Text = e.AffectedRows.ToString() + " rows deleted. " + e.Exception.Message;
      e.ExceptionHandled = true;
    }

  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>GridViewDeleteEventArgs Keys and Values Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>GridViewDeleteEventArgs Keys and Values Example</h3>

      <asp:label id="Message"
        forecolor="Red"          
        runat="server"/>

      <br/>

      <asp:label id="LogTextLabel"
        forecolor="Red"          
        runat="server"/>

      <br/>

      <asp:label id="LogErrorLabel"
        forecolor="Red"          
        runat="server"/>

      <br/>

      <asp:gridview id="CustomersGridView" 
        allowpaging="true"
        datasourceid="CustomersSqlDataSource" 
        autogeneratecolumns="true"
        autogeneratedeletebutton="true" 
        datakeynames="CustomerID"
        onrowdeleted="CustomersGridView_RowDeleted"
        onrowdeleting="CustomersGridView_RowDeleting"   
        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]"
        deletecommand="Delete from Customers where CustomerID = @CustomerID"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"
        runat="server">
      </asp:sqldatasource>

    </form>
  </body>
</html>

.NET Framework
Available since 2.0
Return to top
Show: