SortMode プロパティ

使用される並べ替えモードを取得または設定します。

構文

Visual Basic (宣言)
C#

Public Property SortMode As SortMode

public SortMode SortMode {get; set;}

プロパティ値

SortMode値の1つ。既定値はSortMode.NotSortableです。

例外

例外	解説
System.ComponentModel.InvalidEnumArgumentException	指定された値がMultiRowEllipsisMode値の1つではありません。
System.InvalidOperationException	指定された値がSortMode.NotSortableであり、SortGlyphDirectionがSystem.Windows.Forms.SortOrder.Noneではありません。または指定された値がSortMode.Automaticであり、SelectionModeがMultiRowSelectionMode.Noneではありません。

解説

System.ComponentModel.InvalidEnumArgumentException

指定された値がMultiRowEllipsisMode値の1つではありません。

System.InvalidOperationException

指定された値がSortMode.NotSortableであり、SortGlyphDirectionがSystem.Windows.Forms.SortOrder.Noneではありません。

または

指定された値がSortMode.Automaticであり、SelectionModeがMultiRowSelectionMode.Noneではありません。

解説

このプロパティを設定するときは、SortCellIndexまたはSortCellNameも設定します。

このプロパティをSortMode.Automaticに設定し、SortCellIndexまたはSortCellNameを指定した場合、このColumnHeaderCellをクリックすると行の指定したセルが自動的に並べ替えられ、並べ替え順序を示す並べ替えグリフがセルに表示されます。この動作は、SelectionModeと一緒には使用できません。

SortModeプロパティの値がProgrammaticに設定された列を使用してコントロールを並べ替える場合は、SortGlyphDirectionプロパティを使用して手動で並べ替えグリフを表示する必要があります。

使用例

次のサンプルコードは、列ヘッダセルをマウスでクリックしたときに並べ替えが行われるようにする方法を示します。このサンプルを実行するには、フォームにGcMultiRowコントロールを作成し、次のコードをForm.Loadイベントハンドラにコピーします。

C#
Visual Basic

private void Form1_Load(object sender, EventArgs e)
{
    Template template1 = Template.CreateGridTemplate(4);

    ColumnHeaderCell columnHeaderCell = template1.ColumnHeaders[0][0] as ColumnHeaderCell;

    columnHeaderCell.SelectionMode = MultiRowSelectionMode.None;
    columnHeaderCell.SortMode = SortMode.Automatic;
    columnHeaderCell.SortCellName = "textBoxCell1";

    gcMultiRow1.Template = template1;
}

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
    Dim template1 As Template = Template.CreateGridTemplate(4)

    Dim columnHeaderCell As ColumnHeaderCell = TryCast(template1.ColumnHeaders(0)(0), ColumnHeaderCell)

    columnHeaderCell.SelectionMode = MultiRowSelectionMode.None
    columnHeaderCell.SortMode = SortMode.Automatic
    columnHeaderCell.SortCellName = "textBoxCell1"

    gcMultiRow1.Template = template1
End Sub

参照

ColumnHeaderCell クラス
 ColumnHeaderCell メンバ
 SortCellIndex プロパティ
 SortCellName プロパティ
 SortGlyphDirection プロパティ