Windows フォーム DataGridView コントロール内の列の並べ替えモード
DataGridView 列には、3 つの並べ替えモードがあります。 各列の並べ替えモードは、列の SortMode プロパティによって指定されます。このプロパティは、次の DataGridViewColumnSortMode 列挙値のいずれかに設定できます。
DataGridViewColumnSortMode の値 |
説明 |
|---|---|
テキスト ボックス列の既定値です。 列ヘッダーを選択用として使用する場合を除き、ヘッダーをクリックすると、この列で DataGridView が自動的に並べ替えられ、並べ替え順序を示すグリフが表示されます。 |
|
非テキスト ボックス列の既定値です。 この列は、プログラムによって並べ替えることができますが、並べ替えを目的としていないため、並べ替えグリフの表示領域は予約されません。 |
|
この列はプログラムによって並べ替えることができ、並べ替えグリフの表示領域が予約されます。 |
意味のある順序で並べることができる値が列に含まれている場合は、既定で NotSortable に設定される列の並べ替えモードを変更できます。 たとえば、項目の状態を表す数値がデータベース列に含まれている場合、イメージ列をデータベース列に関連付けることによって、これらの数値を対応するアイコンとして表示できます。 次に、DataGridView.CellFormatting イベントのハンドラーで、数値セルの値をイメージ表示値に変更できます。 この場合、SortMode プロパティにAutomatic を設定すると、ユーザーによる列の並べ替えが可能になります。 自動並べ替えにより、ユーザーは、数値に対応する状態が自然なシーケンスでない場合でも、同じ状態の項目をグループ化できます。 自動並べ替えは、チェック ボックス列の場合にも同じ状態の項目をグループ化するのに役立ちます。
DataGridView は、SortMode の設定と無関係に、任意の列または複数の列の値を基準にして、プログラムによって並べ替えることができます。 プログラムによる並べ替えは、独自の並べ替え用ユーザー インターフェイス (UI) を提供したり、カスタムの並べ替え機能を実装したりする場合に役立ちます。 独自の並べ替え UI の提供は、たとえば、DataGridView 選択モードを設定して列ヘッダーの選択を有効にする場合に役立ちます。 この場合、列ヘッダーは並べ替えで使用できませんが、適切な並べ替えグリフをヘッダーに表示して、SortMode プロパティに Programmatic を設定できます。
プログラムによる並べ替えモードに設定された列には、並べ替えグリフが自動的には表示されません。 このような列では、DataGridViewColumnHeaderCell.SortGlyphDirection プロパティを設定して、グリフを独自に表示する必要があります。 これは、カスタムの並べ替えを柔軟にする場合に必要です。 たとえば、複数の列で DataGridView を並べ替える場合、複数の並べ替えグリフを表示したり、1 つも表示しないようにしたりする必要があります。
DataGridView は、任意の列を基準にプログラムによって並べ替えることができますが、ボタン列などの一部の列には、意味のある順序で並べることのできる値を格納できないことがあります。 このような列では、NotSortable の SortMode プロパティ設定により、列が並べ替えで使用されないため、並べ替えグリフの表示領域をヘッダーで予約する必要がないことが示されています。
DataGridView を並べ替えるときは、SortedColumn プロパティと SortOrder プロパティの値をチェックにして、並べ替え列と並べ替え順序を共に確認できます。 これらの値は、カスタムの並べ替え操作を実行した後には意味がなくなります。 カスタムの並べ替えの詳細については、後記の「カスタムの並べ替え」を参照してください。
バインド列と非バインド列の両方を含む DataGridView コントロールを並べ替えるときは、非バインド列の値を自動的に保持できません。 これらの値を保持するには、VirtualMode プロパティに true を設定し、CellValueNeeded イベントと CellValuePushed イベントを処理して、仮想モードを実装する必要があります。 詳細については、「方法 : Windows フォーム DataGridView コントロールで仮想モードを実装する」を参照してください。 バインド モードでの非バインド列による並べ替えはサポートされません。
プログラムによる並べ替え
DataGridView をプログラムによって並べ替えるには、Sort メソッドを呼び出します。
Sort メソッドの Sort(DataGridViewColumn,ListSortDirection) オーバーロードでは、パラメーターとして DataGridViewColumn 列挙値と ListSortDirection 列挙値を受け取ります。 このオーバーロードは、意味のある順序で並べることができる値を含んでいても、自動並べ替えを設定するのが望ましくない列で並べ替える場合に役立ちます。 このオーバーロードを呼び出し、SortMode プロパティ値が DataGridViewColumnSortMode.Automatic の列に渡すと、SortedColumn プロパティと SortOrder プロパティが自動的に設定され、適切な並べ替えグリフが列ヘッダーに表示されます。
注意
DataSource プロパティを設定して、DataGridView コントロールを外部データ ソースにバインドした場合、Sort(DataGridViewColumn,ListSortDirection) メソッド オーバーロードは、非バインド列に対して使用できません。 また、VirtualMode プロパティが true の場合、このオーバーロードは、バインド列に対してのみ呼び出すことができます。 列がデータ バインドかどうかを確認するには、IsDataBound プロパティ値を調べます。 バインド モードでの非バインド列の並べ替えはサポートされません。
カスタムの並べ替え
DataGridView をカスタマイズするには、Sort メソッドの Sort(IComparer) オーバーロードを使用するか、SortCompare イベントを処理します。
Sort(IComparer) メソッド オーバーロードでは、IComparer インターフェイスを実装するクラスのインスタンスをパラメーターとして受け取ります。 このオーバーロードが役立つのは、たとえば、列の値が自然な並べ替え順序を持たない場合や自然な並べ替え順序が不適切な場合など、カスタムな並べ替えを実現する場合です。 この場合、自動並べ替えは使用できませんが、ユーザーが列ヘッダーをクリックして並べ替えることができます。 列ヘッダーを選択用として使用しない場合は、このオーバーロードを ColumnHeaderMouseClick イベントのハンドラーで呼び出すことができます。
注意
Sort(IComparer) メソッド オーバーロードは、DataGridView コントロールが外部データ ソースにバインドされておらず、VirtualMode プロパティ値が false のときにのみ使用できます。 外部データ ソースにバインドされた列の並べ替えをカスタマイズするには、データ ソースによって提供される並べ替え操作を使用する必要があります。 仮想モードでは、非バインド列に対して独自の並べ替え操作を実行できるようにする必要があります。
Sort(IComparer) メソッド オーバーロードを使用するには、IComparer インターフェイスを実装する独自のクラスを作成する必要があります。 このインターフェイスでは、クラスで IComparer.Compare メソッドを実装する必要があります。このメソッドには、Sort(IComparer) メソッド オーバーロードが呼び出されたときに、DataGridView から DataGridViewRow オブジェクトが入力として渡されます。 これにより、任意の列の値を基にして適切な行の順序を計算できます。
Sort(IComparer) メソッド オーバーロードは、SortedColumn プロパティと SortOrder プロパティを設定しないため、並べ替えグリフが表示されるように常に DataGridViewColumnHeaderCell.SortGlyphDirection プロパティを設定する必要があります。
Sort(IComparer) メソッド オーバーロードを使用する代わりに、SortCompare イベントのハンドラーを実装して、カスタムの並べ替えを可能にすることもできます。 このイベントは、自動並べ替えが設定された列のヘッダーをユーザーがクリックしたり、Sort メソッドの Sort(DataGridViewColumn,ListSortDirection) オーバーロードを呼び出したりすると発生します。 このイベントは、コントロール内の行の各ペアに対して発生するため、行の適切な順序を計算できます。
注意
SortCompare イベントは、DataSource プロパティが設定されている場合や、VirtualMode プロパティ値が true の場合には発生しません。
参照
処理手順
方法 : Windows フォーム DataGridView コントロール内の列の並べ替えモードを設定する
参照
DataGridViewColumnHeaderCell.SortGlyphDirection
概念
方法 : Windows フォーム DataGridView コントロールの並べ替え機能をカスタマイズする