DataGridSortCommandEventArgs Class

 
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.

Provides data for the SortCommand event of the DataGrid control. This class cannot be inherited.

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

System.Object
  System.EventArgs
    System.Web.UI.WebControls.DataGridSortCommandEventArgs

type DataGridSortCommandEventArgs = 
    class
        inherit EventArgs
    end

NameDescription
System_CAPS_pubmethodDataGridSortCommandEventArgs(Object, DataGridCommandEventArgs)

Initializes a new instance of the DataGridSortCommandEventArgs class.

NameDescription
System_CAPS_pubpropertyCommandSource

Gets the source of the command.

System_CAPS_pubpropertySortExpression

Gets the expression used to sort the DataGrid control.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

When sorting is enabled by setting the AllowSorting property of the DataGrid control to true, LinkButton controls are rendered in the header of each column that has the SortExpression property set. (For automatically generated columns, the SortExpression property contains the same value as the data field.) These links allow you to sort the DataGrid control by the selected column. The SortCommand event is raised when a LinkButton control is clicked.

For a list of initial property values for an instance of DataGridSortCommandEventArgs, see the DataGridSortCommandEventArgs constructor.

For more information about handling events, see NIB: Events and Delegates.

The following code example demonstrates how to specify and code a handler for the SortCommand event to sort a DataGrid control.

No code example is currently available or this language may not be supported.
No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: