Sort(Int32,SortOrder) メソッド

GcMultiRowコントロールの内容を、IComparerインタフェースの実装を使用して並べ替えます。

構文

Visual Basic (宣言)
C#

Public Overloads Sub Sort( _
   ByVal cellIndex As Integer, _
   ByVal sortOrder As SortOrder _
)

public void Sort( 
   int cellIndex,
   SortOrder sortOrder
)

パラメータ

cellIndex: GcMultiRowの内容を並べ替える基準となるセルのインデックス。
sortOrder: 並べ替え順序。

例外

例外	解説
System.ArgumentOutOfRangeException	cellIndexが0未満か、RowのCellの数 - 1を超えています。
System.ComponentModel.InvalidEnumArgumentException	sortOrderが、列挙体System.Windows.Forms.SortOrderの有効な値ではありません。
System.InvalidOperationException	このメソッドは、Templateがnull 参照 (Visual Basicでは Nothing)の場合には使用できません。または VirtualModeがtrueで、なおかつDataSourceがnull 参照 (Visual Basicでは Nothing)です。

解説

System.ArgumentOutOfRangeException

cellIndexが0未満か、RowのCellの数 - 1を超えています。

System.ComponentModel.InvalidEnumArgumentException

sortOrderが、列挙体System.Windows.Forms.SortOrderの有効な値ではありません。

System.InvalidOperationException

このメソッドは、Templateがnull 参照 (Visual Basicでは Nothing)の場合には使用できません。

または

VirtualModeがtrueで、なおかつDataSourceがnull 参照 (Visual Basicでは Nothing)です。

解説

このメソッドは、指定したセルの値を同じセルインデックスの値と比較して、GcMultiRowの内容を並べ替えます。既定では、System.Collections.Comparer.Compare(System.Object,System.Object)メソッドを使用して、セルのペアのCell.Valueプロパティが比較されます。

ColumnHeaderCellのCellMouseClickイベントのイベントハンドラを記述して、このメソッドを呼び出すことができます。この場合は通常、SortModeプロパティをSortMode.Programmaticに設定して、並べ替えが自動的に行われないようにし、並べ替えグリフを表示するスペースを設けます。Programmatic並べ替えモードに設定されたセルで並べ替えるときは、SortGlyphDirectionプロパティを設定して、並べ替えグリフを自分で表示する必要があります。

AllowUserToAddRowsプロパティの値がtrueの場合は、最後の行が常に最後の行になります。この場合、並べ替え演算子は最後の行（コミットされていない新しい行）には作用しません。

使用例

次のサンプルコードは、GcMultiRowコントロールをコードによって並べ替える方法を示します。このサンプルを実行するには、フォームにGcMultiRowコントロールを作成し、テンプレートを設定します。このテンプレートには、1つ以上のセルを含む行が必要です。このメソッドをボタンクリックイベントハンドラやフォームの読み込み時などに呼び出すと、最初のセルが昇順に並べ替えられます。

C#
Visual Basic

void SortByCode()
{
    // Sort first cell of all rows.
    this.gcMultiRow1.Sort(0);
}

Private Sub SortByCode()
    ' Sort first cell of all rows.
    Me.gcMultiRow1.Sort(0)
End Sub

参照

GcMultiRow クラス
 GcMultiRow メンバ
 オーバーロード一覧