System.Web.UI.WebControls.GridViewSortEventArgs Class

Provides data for the GridView.Sorting event.

See Also: GridViewSortEventArgs Members


public class GridViewSortEventArgs : System.ComponentModel.CancelEventArgs


The System.Web.UI.WebControls.GridView control raises the GridView.Sorting event when a Sort button (a button with its CommandName property set to "Sort") is clicked, but before the System.Web.UI.WebControls.GridView control handles the sort operation. This allows you to provide an event-handling method that performs a custom routine, such as canceling the sorting operation, whenever this event occurs.


Although any button within a System.Web.UI.WebControls.GridView control with its CommandName property set to "Sort" will raise the GridView.Sorting event, Sort buttons typically appear in the header row of a System.Web.UI.WebControls.GridView control.

A System.Web.UI.WebControls.GridViewSortEventArgs object is passed to the event-handling method, which allows you to specify or determine the sort expression and sort direction in which to sort the System.Web.UI.WebControls.GridView control. To determine the sort expression, use the GridViewSortEventArgs.SortExpression property. To determine the sort direction, use the GridViewSortEventArgs.SortDirection property. You can also cancel a sorting operation by setting the System.ComponentModel.CancelEventArgs.Cancel property to true.

For more information about handling events, see Consuming Events.

For a list of initial property values for an instance of System.Web.UI.WebControls.GridViewSortEventArgs, see the GridViewSelectEventArgs.#ctor(int) constructor.


Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
Assembly Versions:
Since: .NET 2.0