MENU
  1. ホーム
  2. C#
  3. フォーム
  4. コモンコントロール
  5. ListBox
  6. [C#] ListBoxのデータバインド方法と活用法

[C#] ListBoxのデータバインド方法と活用法

ListBox

C#のListBoxにデータバインドする方法は、主にデータソースを設定し、データを表示するプロパティを指定することです。

データソースには、配列、リスト、データテーブルなどが使用できます。

例えば、ListBox.DataSourceプロパティにデータソースを設定し、ListBox.DisplayMemberで表示するプロパティを指定します。

これにより、ListBoxはデータソースの内容を自動的に表示します。

活用法としては、ユーザーが選択可能なリストを動的に生成したり、データベースから取得したデータを表示する際に便利です。

データバインドを使用することで、コードの簡潔化とメンテナンス性の向上が図れます。

この記事でわかること
  • ListBoxへのデータバインド方法
  • データバインドの設定手順
  • ListBoxのイベント処理方法
  • データバインドの応用例
  • 効率的なデータ管理の方法

目次から探す

ListBoxへのデータバインド方法

C#のWindowsフォームアプリケーションにおいて、ListBoxにデータをバインドする方法はいくつかあります。

ここでは、配列、リスト、データテーブル、カスタムオブジェクトを使用したデータバインドの方法を解説します。

配列を使用したデータバインド

配列を使用してListBoxにデータをバインドする方法は非常にシンプルです。

以下のサンプルコードでは、文字列の配列をListBoxにバインドしています。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // 文字列の配列を作成
        string[] items = { "アイテム1", "アイテム2", "アイテム3" };
        // ListBoxにデータをバインド
        listBox1.DataSource = items; 
    }
}

このコードを実行すると、ListBoxには「アイテム1」、「アイテム2」、「アイテム3」が表示されます。

リストを使用したデータバインド

List<T>を使用してデータをバインドすることも可能です。

以下のサンプルコードでは、List<string>を使用しています。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // 文字列のリストを作成
        List<string> items = new List<string> { "アイテムA", "アイテムB", "アイテムC" };
        // ListBoxにデータをバインド
        listBox1.DataSource = items; 
    }
}

このコードを実行すると、ListBoxには「アイテムA」、「アイテムB」、「アイテムC」が表示されます。

データテーブルを使用したデータバインド

データテーブルを使用してListBoxにデータをバインドすることもできます。

以下のサンプルコードでは、DataTableを使用しています。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // データテーブルを作成
        DataTable dataTable = new DataTable();
        dataTable.Columns.Add("Name"); // 列を追加
        dataTable.Rows.Add("データ1"); // 行を追加
        dataTable.Rows.Add("データ2");
        dataTable.Rows.Add("データ3");
        // ListBoxにデータをバインド
        listBox1.DataSource = dataTable; 
        listBox1.DisplayMember = "Name"; // 表示する列を指定
    }
}

このコードを実行すると、ListBoxには「データ1」、「データ2」、「データ3」が表示されます。

カスタムオブジェクトを使用したデータバインド

カスタムオブジェクトを使用してListBoxにデータをバインドすることもできます。

以下のサンプルコードでは、カスタムクラスを作成し、そのリストをバインドしています。

public class Item
{
    public string Name { get; set; } // プロパティ
}
partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // カスタムオブジェクトのリストを作成
        List<Item> items = new List<Item>
        {
            new Item { Name = "カスタムアイテム1" },
            new Item { Name = "カスタムアイテム2" },
            new Item { Name = "カスタムアイテム3" }
        };
        // ListBoxにデータをバインド
        listBox1.DataSource = items; 
        listBox1.DisplayMember = "Name"; // 表示するプロパティを指定
    }
}

このコードを実行すると、ListBoxには「カスタムアイテム1」、「カスタムアイテム2」、「カスタムアイテム3」が表示されます。

データバインドの設定

ListBoxにデータをバインドする際には、いくつかのプロパティを設定する必要があります。

ここでは、DataSource、DisplayMember、ValueMemberの各プロパティについて詳しく解説します。

DataSourceプロパティの設定

DataSourceプロパティは、ListBoxにバインドするデータソースを指定します。

配列、リスト、データテーブル、カスタムオブジェクトなど、さまざまなデータソースを指定できます。

以下のサンプルコードでは、List<string>をDataSourceに設定しています。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // 文字列のリストを作成
        List<string> items = new List<string> { "アイテム1", "アイテム2", "アイテム3" };
        // ListBoxにデータをバインド
        listBox1.DataSource = items; // DataSourceプロパティの設定
    }
}

このコードを実行すると、ListBoxには「アイテム1」、「アイテム2」、「アイテム3」が表示されます。

DisplayMemberプロパティの設定

DisplayMemberプロパティは、データソース内のどのプロパティを表示するかを指定します。

特にカスタムオブジェクトやデータテーブルを使用する場合に重要です。

以下のサンプルコードでは、カスタムオブジェクトのリストを使用し、DisplayMemberを設定しています。

public class Item
{
    public string Name { get; set; } // 表示するプロパティ
}
partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // カスタムオブジェクトのリストを作成
        List<Item> items = new List<Item>
        {
            new Item { Name = "カスタムアイテム1" },
            new Item { Name = "カスタムアイテム2" }
        };
        // ListBoxにデータをバインド
        listBox1.DataSource = items; 
        listBox1.DisplayMember = "Name"; // DisplayMemberプロパティの設定
    }
}

このコードを実行すると、ListBoxには「カスタムアイテム1」、「カスタムアイテム2」が表示されます。

ValueMemberプロパティの設定

ValueMemberプロパティは、データソース内のどのプロパティを値として使用するかを指定します。

通常、選択された項目の値を取得する際に使用します。

以下のサンプルコードでは、データテーブルを使用し、ValueMemberを設定しています。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // データテーブルを作成
        DataTable dataTable = new DataTable();
        dataTable.Columns.Add("ID"); // ID列を追加
        dataTable.Columns.Add("Name"); // Name列を追加
        dataTable.Rows.Add(1, "データ1"); // 行を追加
        dataTable.Rows.Add(2, "データ2");
        // ListBoxにデータをバインド
        listBox1.DataSource = dataTable; 
        listBox1.DisplayMember = "Name"; // 表示する列を指定
        listBox1.ValueMember = "ID"; // ValueMemberプロパティの設定
    }
}

このコードを実行すると、ListBoxには「データ1」、「データ2」が表示され、選択された項目のIDを取得することができます。

選択された項目のIDは、listBox1.SelectedValueで取得できます。

ListBoxのイベントと操作

ListBoxを使用する際には、ユーザーの操作に応じてイベントを処理したり、項目を追加・削除したりすることが重要です。

ここでは、項目選択イベントの処理、項目の追加と削除、選択された項目の取得について解説します。

項目選択イベントの処理

ListBoxの項目が選択されたときに発生するイベントを処理することで、ユーザーの選択に応じたアクションを実行できます。

以下のサンプルコードでは、SelectedIndexChangedイベントを使用して、選択された項目を表示しています。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // ListBoxにデータをバインド
        listBox1.DataSource = new List<string> { "アイテム1", "アイテム2", "アイテム3" };
        
        // 項目選択イベントの処理
        listBox1.SelectedIndexChanged += ListBox1_SelectedIndexChanged; 
    }
    private void ListBox1_SelectedIndexChanged(object sender, EventArgs e)
    {
        // 選択された項目を表示
        string selectedItem = listBox1.SelectedItem.ToString(); 
        MessageBox.Show("選択された項目: " + selectedItem); 
    }
}

このコードを実行すると、ListBoxの項目を選択するたびに、選択された項目がメッセージボックスで表示されます。

項目の追加と削除

ListBoxに項目を追加したり、削除したりすることも簡単です。

以下のサンプルコードでは、ボタンをクリックすることで項目を追加・削除する機能を実装しています。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // ListBoxにデータをバインド
        listBox1.DataSource = new List<string> { "アイテム1", "アイテム2", "アイテム3" };
        
        // 項目追加ボタンのクリックイベント
        buttonAdd.Click += ButtonAdd_Click; 
        
        // 項目削除ボタンのクリックイベント
        buttonRemove.Click += ButtonRemove_Click; 
    }
    private void ButtonAdd_Click(object sender, EventArgs e)
    {
        // 新しい項目を追加
        listBox1.Items.Add("新しいアイテム"); 
    }
    private void ButtonRemove_Click(object sender, EventArgs e)
    {
        // 選択された項目を削除
        if (listBox1.SelectedItem != null)
        {
            listBox1.Items.Remove(listBox1.SelectedItem); 
        }
    }
}

このコードを実行すると、「項目追加」ボタンをクリックすることで新しいアイテムが追加され、「項目削除」ボタンをクリックすることで選択されたアイテムが削除されます。

選択された項目の取得

ListBoxから選択された項目を取得する方法も重要です。

以下のサンプルコードでは、ボタンをクリックすることで選択された項目を取得し、表示しています。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // ListBoxにデータをバインド
        listBox1.DataSource = new List<string> { "アイテム1", "アイテム2", "アイテム3" };
        
        // 選択された項目を表示するボタンのクリックイベント
        buttonShowSelected.Click += ButtonShowSelected_Click; 
    }
    private void ButtonShowSelected_Click(object sender, EventArgs e)
    {
        // 選択された項目を取得
        if (listBox1.SelectedItem != null)
        {
            string selectedItem = listBox1.SelectedItem.ToString(); 
            MessageBox.Show("選択された項目: " + selectedItem); 
        }
        else
        {
            MessageBox.Show("項目が選択されていません。"); 
        }
    }
}

このコードを実行すると、「選択された項目を表示」ボタンをクリックすることで、選択された項目がメッセージボックスで表示されます。

選択されていない場合は、その旨が表示されます。

データバインドの応用例

ListBoxのデータバインド機能を活用することで、さまざまな応用が可能です。

ここでは、フィルタリング機能、ソート機能、データベースとの連携について解説します。

フィルタリング機能の実装

フィルタリング機能を実装することで、ユーザーが特定の条件に基づいてListBoxの表示内容を絞り込むことができます。

以下のサンプルコードでは、テキストボックスに入力された文字列に基づいてListBoxの項目をフィルタリングしています。

partial class MyForm : Form
{
    private List<string> items; // 元のデータリスト
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // 元のデータリストを作成
        items = new List<string> { "Apple", "Banana", "Cherry", "Date", "Grape" };
        
        // ListBoxにデータをバインド
        listBox1.DataSource = items; 
        // フィルタリングボタンのクリックイベント
        buttonFilter.Click += ButtonFilter_Click; 
    }
    private void ButtonFilter_Click(object sender, EventArgs e)
    {
        // テキストボックスの内容でフィルタリング
        string filterText = textBoxFilter.Text.ToLower(); 
        var filteredItems = items.Where(item => item.ToLower().Contains(filterText)).ToList(); 
        // フィルタリングされたリストをListBoxにバインド
        listBox1.DataSource = filteredItems; 
    }
}

このコードを実行すると、テキストボックスに入力された文字列に基づいてListBoxの項目がフィルタリングされます。

ソート機能の実装

ソート機能を実装することで、ListBoxの項目を特定の順序で表示することができます。

以下のサンプルコードでは、ボタンをクリックすることでListBoxの項目をアルファベット順にソートしています。

partial class MyForm : Form
{
    private List<string> items; // 元のデータリスト
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // 元のデータリストを作成
        items = new List<string> { "Banana", "Apple", "Cherry", "Date", "Grape" };
        
        // ListBoxにデータをバインド
        listBox1.DataSource = items; 
        // ソートボタンのクリックイベント
        buttonSort.Click += ButtonSort_Click; 
    }
    private void ButtonSort_Click(object sender, EventArgs e)
    {
        // リストをソート
        var sortedItems = items.OrderBy(item => item).ToList(); 
        // ソートされたリストをListBoxにバインド
        listBox1.DataSource = sortedItems; 
    }
}

このコードを実行すると、「ソート」ボタンをクリックすることでListBoxの項目がアルファベット順に並び替えられます。

データベースとの連携

ListBoxをデータベースと連携させることで、データベースから取得した情報を表示することができます。

以下のサンプルコードでは、SQLiteデータベースからデータを取得し、ListBoxにバインドしています。

using System.Data.SQLite; // SQLiteの使用
partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // データベースからデータを取得
        LoadDataFromDatabase(); 
    }
    private void LoadDataFromDatabase()
    {
        // SQLiteデータベースの接続
        using (var connection = new SQLiteConnection("Data Source=mydatabase.db;Version=3;"))
        {
            connection.Open(); // 接続を開く
            // SQLクエリを実行
            using (var command = new SQLiteCommand("SELECT Name FROM Items", connection))
            {
                using (var reader = command.ExecuteReader())
                {
                    var items = new List<string>(); // データを格納するリスト
                    while (reader.Read())
                    {
                        items.Add(reader["Name"].ToString()); // データをリストに追加
                    }
                    // ListBoxにデータをバインド
                    listBox1.DataSource = items; 
                }
            }
        }
    }
}

このコードを実行すると、SQLiteデータベースから Items テーブルの Name 列のデータが取得され、ListBoxに表示されます。

データベースとの連携により、動的にデータを表示することが可能になります。

よくある質問

データバインドが機能しない場合の対処法は？

データバインドが機能しない場合、以下の点を確認してください。

  • DataSourceの設定: DataSourceプロパティに正しいデータソースが設定されているか確認します。
  • DisplayMemberとValueMemberの設定: カスタムオブジェクトやデータテーブルを使用している場合、DisplayMemberとValueMemberが正しく設定されているか確認します。
  • データソースの変更: データソースが変更された場合、ListBoxのDataSourceを再設定する必要があります。
  • UIスレッドの確認: UIスレッドでデータバインドを行っているか確認します。

バックグラウンドスレッドでUIを更新しようとすると、エラーが発生することがあります。

ListBoxに大量のデータをバインドする際の注意点は？

ListBoxに大量のデータをバインドする際には、以下の点に注意してください。

  • パフォーマンス: 大量のデータを一度にバインドすると、パフォーマンスが低下する可能性があります。

必要に応じて、データをページングするか、仮想化を検討してください。

  • UIの応答性: 大量のデータを処理する際は、UIがフリーズすることがあります。

非同期処理を使用して、UIスレッドをブロックしないようにします。

  • フィルタリングとソート: 大量のデータを扱う場合、フィルタリングやソートの処理を効率的に行うために、LINQやデータベースクエリを活用することが重要です。

データバインドされたListBoxの項目を動的に更新するには？

データバインドされたListBoxの項目を動的に更新するには、以下の方法を使用します。

  • データソースの変更: ListBoxのDataSourceに設定したデータソースを直接変更し、再バインドします。

例えば、リストに新しい項目を追加したり、削除したりする場合、ListBoxのDataSourceを再設定します。

  • INotifyPropertyChangedの実装: カスタムオブジェクトを使用している場合、INotifyPropertyChangedインターフェースを実装することで、プロパティの変更をListBoxに通知できます。
  • BindingList<T>の使用: BindingList<T>を使用することで、リストの変更を自動的にListBoxに反映させることができます。

BindingListは、項目の追加や削除を監視し、UIを自動的に更新します。

例：bindingList.Add("新しいアイテム");

まとめ

この記事では、C#のWindowsフォームにおけるListBoxのデータバインド方法やその活用法について詳しく解説しました。

具体的には、配列やリスト、データテーブル、カスタムオブジェクトを使用したデータバインドの方法、さらにフィルタリングやソート、データベースとの連携といった応用例についても触れました。

これらの知識を活用して、実際のアプリケーションにおけるListBoxの使い方をより効果的に実装してみてください。

目次に戻る

当サイトはリンクフリーです。出典元を明記していただければ、ご自由に引用していただいて構いません。

C言語
C++
Python
HTML
Java
HTTP

関連カテゴリーから探す

ListBox
  • URLをコピーしました！

関連記事

目次から探す