Export (0) Print
Expand All
0 out of 4 rated this helpful - Rate this topic

DataGridView.Sort Method (DataGridViewColumn, ListSortDirection)

Sorts the contents of the DataGridView control in ascending or descending order based on the contents of the specified column.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
'Declaration
Public Overridable Sub Sort ( _
	dataGridViewColumn As DataGridViewColumn, _
	direction As ListSortDirection _
)

Parameters

dataGridViewColumn
Type: System.Windows.Forms.DataGridViewColumn

The column by which to sort the contents of the DataGridView.

direction
Type: System.ComponentModel.ListSortDirection

One of the ListSortDirection values.

ExceptionCondition
ArgumentException

The specified column is not part of this DataGridView.

-or-

The DataSource property has been set and the IsDataBound property of the specified column returns false.

ArgumentNullException

dataGridViewColumn is Nothing.

InvalidOperationException

The VirtualMode property is set to true and the IsDataBound property of the specified column returns false.

-or-

The object specified by the DataSource property does not implement the IBindingList interface.

-or-

The object specified by the DataSource property has a IBindingList.SupportsSorting property value of false.

This method sorts the contents of the DataGridView by comparing values in the specified column. By default, the sort operation will use the Compare method to compare pairs of cells in the column using the DataGridViewCell.Value property.

For columns with the SortMode property set to DataGridViewColumnSortMode.Automatic, the SortedColumn and SortOrder properties are set automatically and the appropriate sorting glyph is displayed. For columns with the SortMode property set to DataGridViewColumnSortMode.Programmatic, you must display the sorting glyph yourself through the DataGridViewColumnHeaderCell.SortGlyphDirection property.

You can customize the sorting operation used by this method by handling the SortCompare event. This event occurs only when the DataSource property has not been set.

When the DataSource property has been set, this method works for data-bound columns only. Data-bound columns have had their DataGridViewColumn.DataPropertyName property set. This causes the DataGridViewColumn.IsDataBound property to return true.

If your DataGridView control contains both bound and unbound columns, you must implement virtual mode to maintain the values of the unbound columns when the control is sorted by a bound column. You can do this by setting the VirtualMode property to true and handling the CellValueNeeded event. If the column is editable, you should also handle the CellValuePushed event. For more information about virtual mode, see How to: Implement Virtual Mode in the Windows Forms DataGridView Control. Sorting by unbound columns when the control is data-bound is not supported.

The following code example demonstrates how to use the Sort in a programmatic sort.

Private Sub SortButton_Click(ByVal sender As Object, _
    ByVal e As EventArgs) Handles sortButton.Click

    ' Check which column is selected, otherwise set NewColumn to Nothing. 
    Dim newColumn As DataGridViewColumn
    If dataGridView1.Columns.GetColumnCount(DataGridViewElementStates _
        .Selected) = 1 Then
        newColumn = dataGridView1.SelectedColumns(0)
    Else
        newColumn = Nothing 
    End If 

    Dim oldColumn As DataGridViewColumn = dataGridView1.SortedColumn
    Dim direction As ListSortDirection

    ' If oldColumn is null, then the DataGridView is not currently sorted. 
    If oldColumn IsNot Nothing Then 

        ' Sort the same column again, reversing the SortOrder. 
        If oldColumn Is newColumn AndAlso dataGridView1.SortOrder = _
            SortOrder.Ascending Then
            direction = ListSortDirection.Descending
        Else 

            ' Sort a new column and remove the old SortGlyph.
            direction = ListSortDirection.Ascending
            oldColumn.HeaderCell.SortGlyphDirection = SortOrder.None
        End If 
    Else
        direction = ListSortDirection.Ascending
    End If 


    ' If no column has been selected, display an error dialog  box. 
    If newColumn Is Nothing Then
        MessageBox.Show("Select a single column and try again.", _
            "Error: Invalid Selection", MessageBoxButtons.OK, _
            MessageBoxIcon.Error)
    Else
        dataGridView1.Sort(newColumn, direction)
        If direction = ListSortDirection.Ascending Then
            newColumn.HeaderCell.SortGlyphDirection = SortOrder.Ascending
        Else
            newColumn.HeaderCell.SortGlyphDirection = SortOrder.Descending
        End If 
    End If 

End Sub

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.