DataGridViewSortCompareEventArgs.SortResult Property


Gets or sets a value indicating the order in which the compared cells will be sorted.

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

public int SortResult { get; set; }

Property Value

Type: System.Int32

Less than zero if the first cell will be sorted before the second cell; zero if the first cell and second cell have equivalent values; greater than zero if the second cell will be sorted before the first cell.

Setting this value is typically the last operation you will perform in a handler for the DataGridView.SortCompare event. You will typically set this value to the return value of a comparison method such as String.Compare.

The following code example demonstrates the use of SortResult 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