This documentation is archived and is not being maintained.

GridViewSortEventArgs.SortDirection Property

Gets or sets the direction in which to sort the GridView control.

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

public SortDirection SortDirection { get; set; }
/** @property */
public SortDirection get_SortDirection ()

/** @property */
public void set_SortDirection (SortDirection value)

public function get SortDirection () : SortDirection

public function set SortDirection (value : SortDirection)

Not applicable.

Property Value

One of the SortDirection values.

When the Sorting event is raised, you can use the SortDirection property to determine the order in which the GridView control will sort its items (based on the sort expression) when the sort operation is performed. Because the Sorting event occurs before the sort operation, you can also use the SortDirection property to programmatically set the sort direction.

The following example demonstrates how to use the SortDirection property to determine the direction in which to sort a GridView control. If the user attempts to sort in descending order, the sort operation is canceled.


<%@ 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_Sorting(Object sender, GridViewSortEventArgs e)
  {
    // By default, the sort order toggles when the user clicks 
    // the same sort button repeatedly. For this example, cancel
    // the sort operation if the user attempts to sort in descending
    // order.
    if (e.SortDirection == SortDirection.Descending)
    {
      e.Cancel = true;
      Message.Text = "Sorting in descending order is not supported.";
    }
    else
    {
      Message.Text = "";
    }
  }
  
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>GridViewSortEventArgs SortDirection Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>GridViewSortEventArgs SortDirection Example</h3>

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

      <asp:gridview id="CustomersGridView" 
        datasourceid="CustomersSource" 
        autogeneratecolumns="true"
        allowpaging="true"
        emptydatatext="No data available." 
        allowsorting="true"
        onsorting="CustomersGridView_Sorting"
        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="CustomersSource"
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
        runat="server"/>
        
    </form>
  </body>
</html>


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
Show: