This documentation is archived and is not being maintained.

DataGridViewColumn.SortMode Property

Gets or sets the sort mode for the column.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public DataGridViewColumnSortMode SortMode { get; set; }

Property Value

Type: System.Windows.Forms.DataGridViewColumnSortMode
A DataGridViewColumnSortMode that specifies the criteria used to order the rows based on the cell values in a column.

ExceptionCondition
InvalidOperationException

The value assigned to the property conflicts with SelectionMode.

When a DataGridView control is sorted using a column with a SortMode property value of Automatic, a sorting glyph is automatically displayed in the column header.

When the control is sorted using a column with a SortMode property value of Programmatic, you must display the sorting glyph yourself through the SortGlyphDirection property.

The default sort mode of a DataGridViewTextBoxColumn is Automatic. The default sort mode for other column types is NotSortable.

The SortMode value does not prevent you from sorting a column programmatically, although other restrictions may apply. For more information, see the Sort method.

A SortMode property value of NotSortable will not prevent the DataGridView.ColumnHeaderMouseClick event from occurring, but it will prevent the header from changing its appearance when it is clicked.

The following code example demonstrates how to use the SortMode property.

this.dataGridView1.Columns["Priority"].SortMode =
    DataGridViewColumnSortMode.Automatic;

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: