GridView.OnSorting Method (System.Web.UI.WebControls)

OnSorting Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

GridView..::.OnSorting Method

Updated: April 2009

Raises the Sorting event.

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

Syntax

Visual Basic (Declaration)

Protected Overridable Sub OnSorting ( _
    e As GridViewSortEventArgs _
)

Visual Basic (Usage)

Dim e As GridViewSortEventArgs

Me.OnSorting(e)

protected virtual void OnSorting(
    GridViewSortEventArgs e
)

Visual C++

protected:
virtual void OnSorting(
    GridViewSortEventArgs^ e
)

JScript

protected function OnSorting(
    e : GridViewSortEventArgs
)

Parameters

e: Type: System.Web.UI.WebControls..::.GridViewSortEventArgs
A GridViewSortEventArgs that contains event data.

Exceptions

Exception	Condition
HttpException	There is no handler for the Sorting event.

Remarks

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.

Platforms

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.

Version Information