Windows apps
Collapse the table of content
Expand the table of content
Information
Switch
Switch
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

DataGridView::Sort Method (IComparer^)

.NET Framework (current version)
 

Sorts the contents of the DataGridView control using an implementation of the IComparer interface.

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

C#
C++
F#
VB
Copy 
public:
virtual void Sort(
	IComparer^ comparer
)

Parameters

comparer
Type: System.Collections::IComparer^

An implementation of IComparer that performs the custom sorting operation.

Exception Condition
ArgumentNullException

comparer is null.

InvalidOperationException

VirtualMode is set to true.

-or-

DataSource is not null.

This method allows advanced customization of the sorting feature of the DataGridView class. In order to implement a highly customized sorting operation, you can write an event handler for the ColumnHeaderMouseClick event and call this method with an instance of a class that implements the System.Collections::IComparer interface as a parameter. In this case, you will typically set the DataGridViewColumn::SortMode property to DataGridViewColumnSortMode::Programmatic to disable automatic sorting and to leave room for a sorting glyph. When sorting by columns set to programmatic sort mode, you must display the sorting glyph yourself by setting the DataGridViewColumnHeaderCell::SortGlyphDirection property.

This method works only when the DataSource property is not set. When you bind the DataGridView control to an external data source, you must use the sorting operations provided by that data source. When you provide your own data source by implementing virtual mode, you must also handle the sorting operations yourself.

Calling this method automatically sets the CurrentCell property to null.

The following code example demonstrates how to use the Sort method overload in a multiple column sort scenario. In this example, the IComparer interface is implemented in the RowComparer class.

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show:
© 2017 Microsoft