GridViewSortEventArgs Class
Provides data for the Sorting event.
Assembly: System.Web (in System.Web.dll)
System::EventArgs
System.ComponentModel::CancelEventArgs
System.Web.UI.WebControls::GridViewSortEventArgs
| Name | Description | |
|---|---|---|
 | GridViewSortEventArgs(String^, SortDirection) | Initializes a new instance of the GridViewSortEventArgs class. |
| Name | Description | |
|---|---|---|
 | Cancel | Gets or sets a value indicating whether the event should be canceled.(Inherited from CancelEventArgs.) |
| SortDirection | Gets or sets the direction in which to sort the GridView control. |
| SortExpression | Gets or sets the expression used to sort the items in the GridView control. |
| Name | Description | |
|---|---|---|
| Equals(Object^) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
 | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
| GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
| GetType() | |
| MemberwiseClone() | |
| ToString() | Returns a string that represents the current object.(Inherited from Object.) |
The GridView control raises the Sorting event when a Sort button (a button with its CommandName property set to "Sort") 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.
 Note |
|---|
Although any button within a GridView control with its CommandName property set to "Sort" will raise the Sorting event, Sort buttons typically appear in the header row of a GridView control. |
A GridViewSortEventArgs object is passed to the event-handling method, which allows you to specify or determine the sort expression and sort direction in which to sort the GridView control. To determine the sort expression, use the SortExpression property. To determine the sort direction, use the SortDirection property. You can also cancel a sorting operation by setting the Cancel property to true.
For more information about handling events, see NIB: Consuming Events.
For a list of initial property values for an instance of GridViewSortEventArgs, see the GridViewSelectEventArgs constructor.
The following example demonstrates how to use the GridViewSortEventArgs object passed to the event-handling method to cancel the sorting operation when the user attempts to sort the address column in a GridView control.
Available since 2.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.