DetailsViewModeEventArgs Class

Provides data for the ModeChanging event.

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

public class DetailsViewModeEventArgs : CancelEventArgs
public class DetailsViewModeEventArgs extends CancelEventArgs
public class DetailsViewModeEventArgs extends CancelEventArgs
Not applicable.

The ModeChanging event is raised when a DetailsView control attempts to change between edit, insert, and read-only mode, but before the mode actually changes. This allows you to provide an event handler that performs a custom routine, such as configuring the DetailsView control for a specific mode or canceling the mode change, whenever this event occurs.

A DetailsViewModeEventArgs object is passed to the event handler, which allows you to determine the mode to which the DetailsView control is changing, to determine whether the ModeChanging event was raised as a result of the user canceling an edit operation, or to indicate that an insert operation should be canceled. To determine the new mode, use the NewMode property. You can also use the NewMode property to change to an alternate mode by setting it to one of the DetailsViewMode enumeration values. Use the CancelingEdit property to determine whether the user canceled an edit operation. To cancel an insert 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 the DetailsViewModeEventArgs class, see the DetailsViewModeEventArgs constructor.

The following code example demonstrates how to use the DetailsViewModeEventArgs object passed to the event handler for the ModeChanging event to hide the pager row when the DetailsView control transitions to edit mode.

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<script runat="server">

  void CustomerDetailsView_ModeChanging(Object sender, DetailsViewModeEventArgs e)

    // Use the NewMode property to determine the mode to which the 
    // DetailsView control is transitioning.
    switch (e.NewMode)
      case DetailsViewMode.Edit:
        // Hide the pager row and clear the Label control
        // when transitioning to edit mode.
        CustomerDetailsView.AllowPaging = false;
        MessageLabel.Text = "";
      case DetailsViewMode.ReadOnly:
        // Display the pager row and confirmation message
        // when transitioning to edit mode.
        CustomerDetailsView.AllowPaging = true;
        if (e.CancelingEdit)
          MessageLabel.Text = "Update canceled.";
          MessageLabel.Text = "Update completed.";
      case DetailsViewMode.Insert:
        // Cancel the mode change if the DetailsView
        // control attempts to transition to insert 
        // mode.
        e.Cancel = true;
        MessageLabel.Text = "Unsupported mode.";


<html xmlns="" >
  <head runat="server">
    <title>DetailsViewModeEventArgs Example</title>
    <form id="form1" runat="server">
      <h3>DetailsViewModeEventArgs Example</h3>
      <asp:detailsview id="CustomerDetailsView"

      <asp:label id="MessageLabel"
      <!-- 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]"
        updatecommand="Update [Customers] Set 
          [CompanyName]=@CompanyName, [Address]=@Address, 
          [City]=@City, [PostalCode]=@PostalCode, 
          Where [CustomerID]=@CustomerID" 
          "<%$ ConnectionStrings:NorthWindConnectionString%>" 

  • AspNetHostingPermission  for operating in a hosted environment. Demand value: LinkDemand; Permission value: Minimal.
  • AspNetHostingPermission  for operating in a hosted environment. Demand value: InheritanceDemand; Permission value: Minimal.


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 Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions