DataGrid.AllowSorting Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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
Available since 1.1
Return to top