ListBox Web サーバー コントロールの概要
更新 : 2007 年 11 月
ListBox Web サーバー コントロールを使用すると、定義済みのリストで 1 つ以上の項目を選択できます。
このトピックの内容は次のとおりです。
シナリオ
機能
背景
コード例
クラス リファレンス
シナリオ
ListBox Web サーバー コントロールは、複数の項目を同時に表示して、ユーザーが定義済みの一覧から 1 つ以上の項目を選択できるようにする場合に使用します。ListBox コントロールは、一度に複数の項目を表示でき、ユーザーが複数の項目を選択することもできるという点で、DropDownList コントロールとは異なります。
ページのトップへ
機能
ListBox コントロールを使用すると、以下の処理を実行できます。
特定の数の項目を表示するようにコントロールを設定します。
コントロールのサイズをピクセル単位で設定します。
データ バインディングを使用して、表示する項目の一覧を指定します。
選択された項目を判断します。
選択する項目をプログラムで指定します。
ページのトップへ
背景
通常、ListBox コントロールは、一度に複数の項目を表示するために使用します。リストの外観を制御する方法は、次のとおりです。
表示する行数。特定の数の項目を表示するようにコントロールを設定できます。設定した数以上の項目がコントロールに含まれている場合は、垂直スクロール バーが表示されます。
高さと幅。ピクセルでコントロールのサイズを設定できます。この場合、設定した行数は無視され、コントロールの高さに収まるだけの項目がすべて表示されます。高さと幅をピクセルで設定する代わりに、行数の設定を行うブラウザもあります。
ほかの Web サーバー コントロールと同様に、スタイル オブジェクトを使用してコントロールの外観を指定できます。詳細については、「ASP.NET Web サーバー コントロールと CSS スタイル」を参照してください。
リスト項目
ListBox コントロールは、1 つ以上のリスト項目のコンテナです。各リスト項目は、独自のプロパティを持つ ListItem 型のオブジェクトです。これらのプロパティの説明を次に示します。
プロパティ |
説明 |
---|---|
リストに表示されるテキストを指定します。 |
|
項目に関連付けられる値を含みます。このプロパティを設定すると、値を表示せずに特定の項目に関連付けることができます。たとえば、Text プロパティに色の名前を設定し、Value プロパティにその色の 16 進表現を設定します。 |
|
項目が現在選択されているかどうかを示します。 |
項目をプログラムで操作するには、ListBox コントロールの Items コレクションを使用します。Items コレクションは、標準のコレクションです。このコレクションでは、項目オブジェクトの追加、項目の削除、コレクション自体の消去などを行うことができます。
現在選択している項目は、ListBox コントロールの SelectedItem プロパティで取得できます。コントロールが単一選択モードに設定されている場合、このプロパティは選択された項目を 1 つ返します。コントロールが複数選択モードに設定されている場合、選択された項目を取得するには、Items コレクション全体をループ処理し、各項目の Selected プロパティを調べます。
単一選択と複数選択
通常、ユーザーはリストの項目を 1 つだけクリックして選択できます。ListBox コントロールを設定して複数選択を有効にした場合は、Ctrl キーまたは Shift キーを押しながらクリックすると、複数の項目を選択できます。
コントロールへのデータの連結
ListBox Web サーバー コントロールを使用すると、データ ソース コントロールを使ってページで利用できるオプションを一覧表示できます。ListBox コントロールの各項目は、データ ソースの項目 (通常は個々のデータ レコード) に対応しています。
コントロールには、ソースのフィールドが 1 つ表示されます。コントロールを別のフィールドに関連付けて、項目の値 (表示されません) を設定することもできます。
ほかのサーバー コントロールと同様に、コントロールの色やサイズなどのコントロール プロパティをデータに連結できます。詳細については、「方法 : データ ソースの項目をリスト Web サーバー コントロールに読み込む (Visual Studio)」を参照してください。
ListBox のイベント
ListBox コントロールを使用すると、ユーザーが項目を選択したときに SelectedIndexChanged イベントが発生します。既定では、このイベントが発生してもページはサーバーにポストされませんが、AutoPostBack プロパティに true を設定することで、直接コントロールから強制的にポストバックさせることができます。
メモ : |
---|
自動ポストバック機能を使用するには、ブラウザが ECMAScript (JScript または JavaScript) をサポートしており、このスクリプトがユーザーのブラウザで有効になっている必要があります。 |
コード例
方法 : Web フォーム ページに ListBox Web サーバー コントロールを追加する (Visual Studio)
方法 : リスト Web サーバー コントロールに項目を追加する (Visual Studio)
方法 : リスト Web サーバー コントロールの選択項目を設定する (Visual Studio)
方法 : データ ソースの項目をリスト Web サーバー コントロールに読み込む (Visual Studio)
方法 : リスト Web サーバー コントロールでの変更に応答する
方法 : リスト Web サーバー コントロールの選択項目を確認する
ページのトップへ
クラス リファレンス
ListBox コントロールに関連するクラスの一覧を次の表に示します。
メンバ |
説明 |
---|---|
コントロールのメイン クラスです。 |
|
リストの各項目を表すクラスです。 |
ページのトップへ