カラムの設定

リストボックスを複数列で表示し各項目にサブ項目を設定するには、リストボックスにカラムを追加する必要があります。ここでは、カラムについて解説します。

概要

コンボコントロールのリストボックスでは、ヘッダと項目に複数のカラム（列）を持つことができます。表示できるカラム数に制限はありません。

カラムを設定するには、ListColumns プロパティが参照するListColumnCollection クラスを使用します。ListColumnCollection クラスは、リストの個々のカラムを表すListColumn オブジェクトを保持するコレクションです。

ListColumn オブジェクトは、主に次のプロパティを設定でき、カラムごとに異なるスタイルや動作を適用できます。

AutoWidth （カラムの幅をテキストの長さに応じて自動設定するかどうか設定します。）
DataDisplayType （カラムに表示にテキストを表示するかそれともイメージ画像を表示するかを設定します。）
DefaultSubItem （サブアイテムの初期設定を定義します。）
Header （ヘッダの設定を行います。）
SortOrder （カラムのソート方法を設定します。）
Visible （カラムを表示するかどうか設定します。）
Width （カラムの幅を設定します。AutoWidth プロパティがTrueに設定されているときは無効です。）

また、カラムのインデックスを下記のプロパティに設定することで、それぞれの目的でサブ項目を使用できます。

TextSubItemIndex （サブ項目の内容をコントロールのText プロパティとして使用するカラムのインデックス）
ListDescriptionSubItemIndex （サブ項目の内容をステータスバーに表示するカラムのインデックス）
ListSortColumnIndex（項目のソートに使用するカラムのインデックス）
ValueSubItemIndex（SelectedValue プロパティの対象となるカラムのインデックス）

カラムの追加と削除

コードによる設定

コードからカラムを追加するには、ListColumnCollectionのAdd メソッドまたはAddRange メソッドを使用します。

以下は、Add メソッドを使用してカラムを１つ追加するサンプルコードです。ここではカラムの名前（ヘッダに表示されるテキスト）を指定してカラムを追加しています。

Visual Basic
C#

GcComboBox1.ListColumns.Add(New GrapeCity.Win.Editors.ListColumn("カラム１"))

gcComboBox1.ListColumns.Add(new GrapeCity.Win.Editors.ListColumn("カラム１"));

カラムを削除するには、ListColumnCollection クラスのRemove メソッドまたはRemoveAt メソッドを使用します。

以下は、RemoveAt メソッドを使用して先頭のカラムを１つ削除するサンプルコードです。

Visual Basic
C#

GcComboBox1.ListColumns.RemoveAt(0)

gcComboBox1.ListColumns.RemoveAt(0);

デザイン画面での設定

デザイン画面ではカラムの追加や削除を行える「カラムの編集」エディタから容易な設定が可能です。このエディタは次のいずれかの方法で起動できます。

プロパティページの「項目の設定」-「カラムの編集」を選択
コントロールのスマートタグから「カラムの編集...」を選択
プロパティウィンドウのListColumns プロパティをアクティブにした時に表示される「…」ボタンを押下

「カラムの編集」エディタ

また、スマートタグの「カラムの追加」をクリックすると、カラムが一つ追加されます。

カラムの既定値

コントロールのListDefaultColumn プロパティが参照するDefaultListColumn オブジェクトを使用すると、追加したカラムに既定値を設定することができます。カラムの既定値の設定は、繰り返し設定を変更する手間を省略でき、データソース接続をするとき、AutoGenerateColumns プロパティがTrueで、自動的にカラムを追加する場合などに便利な機能です。

次のサンプルコードは、カラムの既定値を設定する例です。

Visual Basic
C#

GcComboBox1.ListDefaultColumn.AutoWidth = True
GcComboBox1.ListDefaultColumn.Header.AllowResize = True
GcComboBox1.ListDefaultColumn.DefaultSubItem.ContentAlignment = ContentAlignment.MiddleRight

gcComboBox1.ListDefaultColumn.AutoWidth = true;
gcComboBox1.ListDefaultColumn.Header.AllowResize = true;
gcComboBox1.ListDefaultColumn.DefaultSubItem.ContentAlignment = ContentAlignment.MiddleRight;

また、デザイン画面ではカラムの既定値を容易に設定できる「カラムの既定値の設定」エディタが用意されており、このエディタは次のいずれかの方法で起動できます。

プロパティページの「項目の設定」-「カラムの既定値」を選択
コントロールのスマートタグから「カラムの既定値を設定...」を選択
プロパティウィンドウのListDefaultColumns プロパティをアクティブした時に表示される「…」ボタンを押下

「カラムの既定値の設定」エディタ