GridView.OnSorting(GridViewSortEventArgs) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Raises the Sorting event.

protected:
 virtual void OnSorting(System::Web::UI::WebControls::GridViewSortEventArgs ^ e);

protected virtual void OnSorting (System.Web.UI.WebControls.GridViewSortEventArgs e);

abstract member OnSorting : System.Web.UI.WebControls.GridViewSortEventArgs -> unit
override this.OnSorting : System.Web.UI.WebControls.GridViewSortEventArgs -> unit

Protected Overridable Sub OnSorting (e As GridViewSortEventArgs)

Parameters

e: GridViewSortEventArgs

A GridViewSortEventArgs that contains event data.

Exceptions

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 Handling and Raising Events.

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(GridViewSortEventArgs) in a derived class, be sure to call the base class's OnSorting(GridViewSortEventArgs) method so that registered delegates receive the event.

Applies to

Share via