DataGridView.SortedColumn プロパティ

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

DataGridView.SortedColumn プロパティ

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

DataGridView の内容の現在の並べ替えでキーとなっている列を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 SortedColumn As DataGridViewColumn

Visual Basic (使用法)

Dim instance As DataGridView
Dim value As DataGridViewColumn

value = instance.SortedColumn

C#

public DataGridViewColumn SortedColumn { get;
 }

C++

public:
property DataGridViewColumn^ SortedColumn {
    DataGridViewColumn^ get ();
}

J#

/** @property */
public DataGridViewColumn get_SortedColumn ()

JScript

public function get SortedColumn
 () : DataGridViewColumn

プロパティ値
DataGridView の内容の現在の並べ替えでキーとなっている DataGridViewColumn。

解説

DataGridView が並べ替えられていない場合、このプロパティは null 参照 (Visual Basic では Nothing) を返します。

このプロパティによって示される列に、DataGridViewColumnSortMode.Automatic の SortMode プロパティ値が設定されている場合は、SortOrder プロパティの値に基づいて並べ替えグリフが表示されます。

列に DataGridViewColumnSortMode.Programmatic の SortMode プロパティ値が設定されている場合は、DataGridViewColumnHeaderCell.SortGlyphDirection プロパティを使用して、並べ替えグリフを自分で表示する必要があります。

メモ
カスタム並べ替えを使用してコントロールを並べ替える場合、このプロパティの値は無効です。カスタム並べ替えの詳細については、Sort(IComparer) メソッドおよび SortCompare イベントのトピックを参照してください。

使用例

プログラムによる並べ替えで SortedColumn プロパティを使用する方法を示すコード例を次に示します。

Visual Basic

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 Not oldColumn Is
 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

C#

private void sortButton_Click(object sender,
 System.EventArgs e)
{
    // Check which column is selected, otherwise set NewColumn to null.
    DataGridViewColumn newColumn =
        dataGridView1.Columns.GetColumnCount(
        DataGridViewElementStates.Selected) == 1 ?
        dataGridView1.SelectedColumns[0] : null;

    DataGridViewColumn oldColumn = dataGridView1.SortedColumn;
    ListSortDirection direction;

    // If oldColumn is null, then the DataGridView is not currently
 sorted.
    if (oldColumn != null)
    {
        // Sort the same column again, reversing the SortOrder.
        if (oldColumn == newColumn &&
            dataGridView1.SortOrder == SortOrder.Ascending)
        {
            direction = ListSortDirection.Descending;
        }
        else
        {
            // Sort a new column and remove the old SortGlyph.
            direction = ListSortDirection.Ascending;
            oldColumn.HeaderCell.SortGlyphDirection = SortOrder.None;
        }
    }
    else
    {
        direction = ListSortDirection.Ascending;
    }

    // If no column has been selected, display an error dialog  box.
    if (newColumn == null)
    {
        MessageBox.Show("Select a single column and try again."
,
            "Error: Invalid Selection", MessageBoxButtons.OK,
            MessageBoxIcon.Error);
    }
    else
    {
        dataGridView1.Sort(newColumn, direction);
        newColumn.HeaderCell.SortGlyphDirection =
            direction == ListSortDirection.Ascending ?
            SortOrder.Ascending : SortOrder.Descending;
    }
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, 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

参照

関連項目
DataGridView クラス
DataGridView メンバ
System.Windows.Forms 名前空間
その他の技術情報
DataGridView コントロール (Windows フォーム)