DataGridViewSortCompareEventArgs.SortResult プロパティ

.NET Framework クラス ライブラリ リファレンス

DataGridViewSortCompareEventArgs.SortResult プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

比較されたセルを並べ替える順序を示す値を取得または設定します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Property SortResult As
 Integer

Visual Basic (使用法)

Dim instance As DataGridViewSortCompareEventArgs
Dim value As Integer

value = instance.SortResult

instance.SortResult = value

C#

public int SortResult { get;
 set; }

C++

public:
property int SortResult {
    int get ();
    void set (int value);
}

J#

/** @property */
public int get_SortResult ()

/** @property */
public void set_SortResult (int
 value)

JScript

public function get SortResult
 () : int

public function set SortResult
 (value : int)

プロパティ値
最初のセルを 2 番目のセルよりも前に配置する場合は 0 未満。最初のセルと 2 番目のセルの値が同じである場合は 0。2 番目のセルを最初のセルよりも前に配置する場合は 0 を超える値。

解説

この値の設定は、通常、DataGridView.SortCompare イベントのハンドラで行う最後の操作です。この値には、通常、System.String.Compare などの比較メソッドの戻り値を設定します。

使用例

次のコード例では、複数列の並べ替えで SortResult を使用する方法を示します。この例は 方法 : Windows フォーム DataGridView コントロールの並べ替え機能をカスタマイズする の例の一部です。

Visual Basic

Private Sub DataGridView1_SortCompare( _
    ByVal sender As Object,
 ByVal e As DataGridViewSortCompareEventArgs)
 _
    Handles DataGridView1.SortCompare

    ' Try to sort based on the contents of the cell 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) AndAlso Not
 (e.Column.Name = "ID") Then
        e.SortResult = System.String.Compare( _
            DataGridView1.Rows(e.RowIndex1).Cells("ID").Value.ToString(),
 _
            DataGridView1.Rows(e.RowIndex2).Cells("ID").Value.ToString())
    End If

    e.Handled = True

End Sub

C#

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(
            dataGridView1.Rows[e.RowIndex1].Cells["ID"].Value.ToString()
,
            dataGridView1.Rows[e.RowIndex2].Cells["ID"].Value.ToString());
    }
    e.Handled = true;
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
DataGridViewSortCompareEventArgs クラス
DataGridViewSortCompareEventArgs メンバ
System.Windows.Forms 名前空間
DataGridView クラス
DataGridView.SortCompare イベント
System.String.Compare
その他の技術情報
方法 : Windows フォーム DataGridView コントロールの並べ替え機能をカスタマイズする