GridView.OnSorting Method (GridViewSortEventArgs)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Raises the Sorting event.

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

Protected Overridable Sub OnSorting (
	e As GridViewSortEventArgs
)

Parameters

e
Type: System.Web.UI.WebControls.GridViewSortEventArgs

A GridViewSortEventArgs that contains event data.

Exception Condition
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 NIB: 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.

.NET Framework
Available since 2.0
Return to top
Show: