This topic has not yet been rated - Rate this topic

DataGrid.AllowSorting Property

Gets or sets a value indicating whether the grid can be resorted by clicking on a column header.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
public bool AllowSorting { get; set; }

Property Value

Type: System.Boolean
true if columns can be sorted; otherwise, false.

This property is overridden by the DataGridTableStyle.AllowSorting property if there is a DataGridTableStyle currently in effect for the control.

If sorting is allowed, clicking on a column header will sort the table data by that column.

You can also sort using an expression for a DataColumn. See Expression for details on creating a sort expression.

If the System.Windows.Forms.DataGrid is bound to a DataView, you can set a custom sort for the table using the DataView class's Sort property. Similarly, if the System.Windows.Forms.DataGrid is bound to a DataViewManager, each table in the DataViewManager can have a custom sort by setting the DataViewSettings class's Sort property.

The following code example toggles the AllowSorting property.

private void ToggleAllowSorting()
{
   // Toggle the AllowSorting property.
   dataGrid1.AllowSorting = ! dataGrid1.AllowSorting;
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.