リストコントロールには、ヘッダを表示する機能が実装されています。以下では、ヘッダの機能について説明します。
リストボックスのヘッダは、次のようにヘッダ全体の領域と、各カラムが保持するカラムヘッダで構成されます。カラムの設定については「カラムの設定」を参照してください。
ヘッダ領域の機能は、ヘッダの表示・非表示の切り替えやヘッダの高さなどヘッダ全体に適用され、ListHeaderPane プロパティが参照するListHeaderPane オブジェクトを使用して設定します。
カラムヘッダは各カラムに対する個別の設定を行い、ListColumn クラスのHeader プロパティで行います。Header プロパティは、ListHeader オブジェクトを参照します。
ヘッダ領域は、ListHeaderPane プロパティが参照するListHeaderPane オブジェクトを使用して設定します。 リストコントロールにヘッダを表示するには、Visible プロパティをTrueに設定します。その他、以下のような外観設定が可能です。
次のサンプルコードは、ヘッダ領域を設定する例です。
GcListBox1.ListHeaderPane.Visible = True GcListBox1.ListHeaderPane.AutoHeight = True
gcListBox1.ListHeaderPane.Visible = true; gcListBox1.ListHeaderPane.AutoHeight = true;
カラムヘッダの設定は、ListColumn クラスのHeader プロパティで行い、Header プロパティは、ListHeader クラスを参照します。
ListHeader クラスを使用して、カラムヘッダには以下のような設定が可能です。
ヘッダのタイトルを変更するには、ListHeader クラスのText プロパティを使用します。
以下にヘッダのテキストを変更する例を示します。次のサンプルコードでは、リストコントロールに予め2つのカラムが追加されていることを前提にしています。
GcListBox1.Columns(0).Header.Text = "カラム1" GcListBox1.Columns(1).Header.Text = "カラム2"
gcListBox1.Columns[0].Header.Text = "カラム1"; gcListBox1.Columns[1].Header.Text = "カラム2";
ListHeader クラスのAllowResize プロパティをTrueに設定すると、アプリケーションの実行時にユーザーはマウス操作等でカラムのサイズを自由に変更できるようになります。
実行時にカラムのサイズ(幅)を変更するには、サイズを変更したいカラムの境界線の位置でマウスの左ボタンを押し、変更したいサイズに合わせてマウスカーソルを移動し、左ボタンを離します。
カラムヘッダにはテキスト以外に画像を表示することができます。
画像を表示するには、ListHeader クラスのImage プロパティを使用します。
Image プロパティには、表示する画像のインデックスを設定します。Image プロパティに設定するインデックスは、コントロールのImageList プロパティに設定したImageList オブジェクトのImages プロパティが参照するImageList.ImageCollection のインデックスです。
表示された画像の位置は、ListHeader クラスのTextAttachAlignment プロパティで設定します。
また、画像とテキストの距離は、ImageTextSpace プロパティで設定します。
以下にヘッダに画像を変更する例を示します。次のサンプルコードでは、リストコントロールに予め2つのカラムが追加されていることを前提にしています。
Imports GrapeCIty.Win.Editors ' ImageListプロパティを設定 Dim iList As New ImageList() iList.Images.Add(Image.FromFile("C:\Image1.bmp")) iList.Images.Add(Image.FromFile("C:\Image2.bmp")) GcListBox1.ImageList = iList ' ヘッダに画像を設定 GcListBox1.Columns(0).Header.Image = 0 GcListBox1.Columns(0).Header.TextAttachAlignment = AttachAlignment.LeftMiddle GcListBox1.Columns(0).Header.ImageTextSpace = 3 GcListBox1.Columns(1).Header.Image = 1 GcListBox1.Columns(1).Header.TextAttachAlignment = AttachAlignment.LeftMiddle GcListBox1.Columns(1).Header.ImageTextSpace = 3
using GrapeCIty.Win.Editors; // ImageListプロパティを設定 ImageList iList = new ImageList(); iList.Images.Add(Image.FromFile("C:\\Image1.bmp")); iList.Images.Add(Image.FromFile("C:\\Image2.bmp")); gcListBox1.ImageList = iList; // ヘッダに画像を設定 gcListBox1.Columns[0].Header.Image = 0; gcListBox1.Columns[0].Header.TextAttachAlignment = AttachAlignment.LeftMiddle; gcListBox1.Columns[0].Header.ImageTextSpace = 3; gcListBox1.Columns[1].Header.Image = 1; gcListBox1.Columns[1].Header.TextAttachAlignment = AttachAlignment.LeftMiddle; gcListBox1.Columns[1].Header.ImageTextSpace = 3;
ListHeader クラスのEllipsis プロパティを使用すると、ヘッダのテキストの長さがカラムの幅より大きいとき、省略文字を表示するかどうか設定することができます。
DefaultColumn プロパティが参照するDefaultListColumn オブジェクトのHeader プロパティを使用すれば、カラムヘッダの既定値することができます。すべてのヘッダに共通の設定は、既定値を設定することで複数のヘッダに同じ設定を繰り返す手間が省けます。
Header プロパティは、ListHeader型のオブジェクトを値に持つプロパティのため、カラムヘッダと同じ設定内容を持ちます。