DataGridViewSortCompareEventHandler Delegate
Collapse the table of content
Expand the table of content

DataGridViewSortCompareEventHandler Delegate


Represents the method that will handle the SortCompare event of a DataGridView control.

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

public delegate void DataGridViewSortCompareEventHandler(
	object sender,
	DataGridViewSortCompareEventArgs e


Type: System.Object

The source of the event.

Type: System.Windows.Forms.DataGridViewSortCompareEventArgs

A DataGridViewSortCompareEventArgs that contains the event data.

When you create a DataGridViewSortCompareEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see NIB: Events and Delegates.

The following code example demonstrates the use of SortCompare in a multiple column sort. This example is part of a larger example provided in How to: Customize Sorting in the Windows Forms DataGridView Control.

private void dataGridView1_SortCompare(object sender,
    DataGridViewSortCompareEventArgs e)
    // Try to sort based on the cells in the current column.
    e.SortResult = System.String.Compare(
        e.CellValue1.ToString(), e.CellValue2.ToString());

    // If the cells are equal, sort based on the ID column.
    if (e.SortResult == 0 && e.Column.Name != "ID")
        e.SortResult = System.String.Compare(
    e.Handled = true;

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft