This documentation is archived and is not being maintained.

GridView.OnSorting Method

Raises the Sorting event.

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

protected virtual void OnSorting (
	GridViewSortEventArgs e
)
protected void OnSorting (
	GridViewSortEventArgs e
)
protected function OnSorting (
	e : GridViewSortEventArgs
)
Not applicable.

Parameters

e

A GridViewSortEventArgs that contains event data.

Exception typeCondition

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