This documentation is archived and is not being maintained.

GridView.OnSorting Method

Updated: April 2009

Raises the Sorting event.

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

protected virtual void OnSorting(
	GridViewSortEventArgs e
)

ExceptionCondition
HttpException

There is no handler for the Sorting event.

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.

Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

The OnSorting method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors:

When overriding OnSorting in a derived class, be sure to call the base class's OnSorting method so that registered delegates receive the event.

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 links to the Sort method and a topic about sorting.

Customer feedback.

Show: