Edit

Share via


ListView.OnSorting(ListViewSortEventArgs) Method

Definition

Raises the Sorting event.

protected:
 virtual void OnSorting(System::Web::UI::WebControls::ListViewSortEventArgs ^ e);
protected virtual void OnSorting (System.Web.UI.WebControls.ListViewSortEventArgs e);
abstract member OnSorting : System.Web.UI.WebControls.ListViewSortEventArgs -> unit
override this.OnSorting : System.Web.UI.WebControls.ListViewSortEventArgs -> unit
Protected Overridable Sub OnSorting (e As ListViewSortEventArgs)

Parameters

e
ListViewSortEventArgs

The event data.

Exceptions

The ListView control is not bound to a data source control by using the DataSourceID property.

Remarks

The Sorting event is raised when a Sort button is clicked or the Sort method is called, but before the ListView control handles the sort operation. (A Sort button is a button control whose CommandName property is set to "Sort".) This enables you to perform a custom routine whenever this event occurs, such as canceling the sorting operation.

Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.

The OnSorting method also enables 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 you override OnSorting(ListViewSortEventArgs) in a derived class, call the base class's OnSorting(ListViewSortEventArgs) method so that registered delegates receive the event.

Applies to

See also