DataGrid.AllowSorting Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets a value indicating whether the grid can be resorted by clicking on a column header.
public:
property bool AllowSorting { bool get(); void set(bool value); };
public bool AllowSorting { get; set; }
member this.AllowSorting : bool with get, set
Public Property AllowSorting As Boolean
Property Value
true
if columns can be sorted; otherwise, false
.
Examples
The following code example toggles the AllowSorting property.
private:
void ToggleAllowSorting()
{
// Toggle the AllowSorting property.
dataGrid1->AllowSorting = !dataGrid1->AllowSorting;
}
private void ToggleAllowSorting()
{
// Toggle the AllowSorting property.
dataGrid1.AllowSorting = ! dataGrid1.AllowSorting;
}
Private Sub ToggleAllowSorting()
' Toggle the AllowSorting property.
DataGrid1.AllowSorting = Not DataGrid1.AllowSorting
End Sub
Remarks
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.