This documentation is archived and is not being maintained.

GridView::Sorting Event

Updated: April 2009

Occurs when the hyperlink to sort a column is clicked, but before the GridView control handles the sort operation.

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

public:
 event GridViewSortEventHandler^ Sorting {
	void add (GridViewSortEventHandler^ value);
	void remove (GridViewSortEventHandler^ value);
}
<asp:GridView OnSorting="GridViewSortEventHandler" />

The Sorting event is raised when the hyperlink to sort a column is clicked, but before the GridView control handles the sort operation. This enables you to provide an event-handling method that performs a custom routine, such as canceling the sorting operation, whenever this event occurs.

A GridViewSortEventArgs object is passed to the event-handling method, which enables you to determine the sort expression for the column and to indicate that the selection operation should be canceled. To cancel the selection operation, set the Cancel property of the GridViewSortEventArgs object to true.

For information about how to programmatically initiate a sort operation, see the Sort method.

For more information about handling events, see Consuming Events.

The following example demonstrates how to use the Sorting event to perform the sorting functionality when the GridView control is bound to a DataTable object by setting the DataSource property programmatically.

No code example is currently available or this language may not be supported.

The following example demonstrates how to use the Sorting event to cancel a sorting operation.

No code example is currently available or this language may not be supported.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0

Date

History

Reason

April 2009

Added a link to the Sort method.

Customer feedback.

August 2008

Added an example.

Customer feedback.

Show: