[C#] BindingSource Filterの使い方と活用法

2024-09-16

BindingSourceのFilterプロパティは、データバインディングされたリストの表示をフィルタリングするために使用されます。

データソースがDataTableやDataViewの場合、FilterプロパティにSQLのWHERE句に似た条件を指定することで、特定の条件に一致するデータだけを表示できます。

例えば、 Age > 30 AND Name LIKE 'A%' のように記述します。

これにより、ユーザーインターフェース上で特定の条件に合致するデータのみを表示し、データの検索や絞り込みを効率的に行うことができます。

Filterプロパティは、データの動的な表示制御に役立ち、ユーザーエクスペリエンスを向上させます。

この記事でわかること

BindingSourceの基本的な使い方
Filterプロパティの設定方法
フィルタリングとソートの組み合わせ
動的なフィルタリングの実装方法
フィルタリングの応用例と実践方法

目次から探す

BindingSourceとは

BindingSourceは、C#のWindowsフォームアプリケーションにおいて、データのバインディングを簡素化するためのクラスです。

主に、データソースとUIコンポーネント(例えば、DataGridViewやTextBoxなど)との間でデータの同期を行う役割を果たします。

BindingSourceを使用することで、データの追加、削除、更新を簡単に行うことができ、UIの更新も自動的に行われるため、開発者はデータ管理に集中できます。

また、Filterプロパティを利用することで、表示するデータを絞り込むことも可能です。

これにより、ユーザーは必要な情報に迅速にアクセスできるようになります。

Filterプロパティの基本

Filterプロパティの概要

Filterプロパティは、BindingSourceクラスの一部であり、データソースに対して適用するフィルタリング条件を指定するためのプロパティです。

このプロパティを使用することで、特定の条件に基づいてデータを絞り込むことができ、ユーザーが必要な情報を迅速に見つける手助けをします。

Filterプロパティには、文字列形式で条件を指定し、データの表示を動的に変更することが可能です。

Filterプロパティの設定方法

Filterプロパティを設定するには、BindingSourceのインスタンスを作成し、そのFilterプロパティに条件を文字列として代入します。

以下は、Filterプロパティを設定する基本的なサンプルコードです。

partial class MyForm : Form
{
    private BindingSource bindingSource = new BindingSource();
    public MyForm()
    {
        InitializeComponent();
        
        // データソースの設定
        bindingSource.DataSource = GetData(); // GetData()はデータを取得するメソッド
        
        // フィルタ条件の設定
        bindingSource.Filter = "Age > 30"; // 年齢が30歳以上のデータを表示
    }
}

このコードでは、bindingSource.Filterに条件を設定することで、年齢が30歳以上のデータのみを表示するようにしています。

SQLのWHERE句との類似点

Filterプロパティで指定する条件は、SQLのWHERE句に似た構文を使用します。

例えば、以下のような条件を指定できます。

ColumnName = 'Value'(特定の値と一致する行を選択)
ColumnName > Value(特定の値より大きい行を選択)
ColumnName LIKE 'Pattern%'(特定のパターンに一致する行を選択)

このように、Filterプロパティを使用することで、SQLのクエリに似た形でデータをフィルタリングできるため、データの絞り込みが直感的に行えます。

Filterプロパティの使い方

単一条件でのフィルタリング

Filterプロパティを使用して、単一の条件でデータをフィルタリングすることができます。

例えば、特定の名前を持つデータのみを表示する場合、以下のように設定します。

partial class MyForm : Form
{
    private BindingSource bindingSource = new BindingSource();
    public MyForm()
    {
        InitializeComponent();
        
        // データソースの設定
        bindingSource.DataSource = GetData(); // GetData()はデータを取得するメソッド
        
        // 単一条件のフィルタリング
        bindingSource.Filter = "Name = '山田太郎'"; // 名前が「山田太郎」のデータを表示
    }
}

このコードでは、bindingSource.Filterに「Name = ‘山田太郎’」という条件を設定することで、名前が「山田太郎」のデータのみを表示しています。

複数条件でのフィルタリング

複数の条件を組み合わせてフィルタリングすることも可能です。

条件をANDまたはORで結合することで、より複雑なフィルタリングができます。

以下は、年齢が30歳以上かつ名前が「山田太郎」のデータを表示する例です。

partial class MyForm : Form
{
    private BindingSource bindingSource = new BindingSource();
    public MyForm()
    {
        InitializeComponent();
        
        // データソースの設定
        bindingSource.DataSource = GetData(); // GetData()はデータを取得するメソッド
        
        // 複数条件のフィルタリング
        bindingSource.Filter = "Age >= 30 AND Name = '山田太郎'"; // 年齢が30歳以上かつ名前が「山田太郎」のデータを表示
    }
}

このコードでは、bindingSource.Filterに複数の条件をANDで結合して設定しています。

特殊文字やワイルドカードの使用

Filterプロパティでは、特殊文字やワイルドカードを使用して、より柔軟なフィルタリングが可能です。

例えば、LIKE演算子を使用して部分一致を行うことができます。

以下は、名前が「山田」で始まるデータを表示する例です。

partial class MyForm : Form
{
    private BindingSource bindingSource = new BindingSource();
    public MyForm()
    {
        InitializeComponent();
        
        // データソースの設定
        bindingSource.DataSource = GetData(); // GetData()はデータを取得するメソッド
        
        // ワイルドカードを使用したフィルタリング
        bindingSource.Filter = "Name LIKE '山田%'"; // 名前が「山田」で始まるデータを表示
    }
}

このコードでは、bindingSource.Filterに「Name LIKE ‘山田%’」という条件を設定することで、名前が「山田」で始まるデータを表示しています。

ワイルドカード % は任意の文字列を表します。

実践的な活用法

DataGridViewでのデータ表示の絞り込み

DataGridViewを使用して、BindingSourceのFilterプロパティを活用することで、データの表示を簡単に絞り込むことができます。

以下は、DataGridViewにデータを表示し、特定の条件でフィルタリングする例です。

partial class MyForm : Form
{
    private BindingSource bindingSource = new BindingSource();
    private DataGridView dataGridView = new DataGridView();
    public MyForm()
    {
        InitializeComponent();
        
        // データソースの設定
        bindingSource.DataSource = GetData(); // GetData()はデータを取得するメソッド
        
        // DataGridViewの設定
        dataGridView.DataSource = bindingSource;
        this.Controls.Add(dataGridView);
        
        // フィルタ条件の設定
        bindingSource.Filter = "Age > 30"; // 年齢が30歳以上のデータを表示
    }
}

このコードでは、DataGridViewにBindingSourceをデータソースとして設定し、年齢が30歳以上のデータのみを表示しています。

これにより、ユーザーは簡単に条件に合ったデータを確認できます。

テキストボックスを使った動的フィルタリング

テキストボックスを使用して、ユーザーが入力した内容に基づいてデータを動的にフィルタリングすることも可能です。

以下は、テキストボックスの内容に応じてフィルタリングを行う例です。

partial class MyForm : Form
{
    private BindingSource bindingSource = new BindingSource();
    private TextBox textBox = new TextBox();
    public MyForm()
    {
        InitializeComponent();
        
        // データソースの設定
        bindingSource.DataSource = GetData(); // GetData()はデータを取得するメソッド
        
        // テキストボックスの設定
        textBox.TextChanged += TextBox_TextChanged; // テキストが変更されたときのイベント
        this.Controls.Add(textBox);
    }
    private void TextBox_TextChanged(object sender, EventArgs e)
    {
        // テキストボックスの内容に基づいてフィルタリング
        bindingSource.Filter = $"Name LIKE '{textBox.Text}%'"; // 名前がテキストボックスの内容で始まるデータを表示
    }
}

このコードでは、テキストボックスの内容が変更されるたびに、BindingSourceのFilterプロパティが更新され、名前がテキストボックスの内容で始まるデータのみが表示されます。

コンボボックスを利用したカテゴリ別フィルタリング

コンボボックスを使用して、特定のカテゴリに基づいてデータをフィルタリングすることもできます。

以下は、コンボボックスの選択に応じてデータをフィルタリングする例です。

partial class MyForm : Form
{
    private BindingSource bindingSource = new BindingSource();
    private ComboBox comboBox = new ComboBox();
    public MyForm()
    {
        InitializeComponent();
        
        // データソースの設定
        bindingSource.DataSource = GetData(); // GetData()はデータを取得するメソッド
        
        // コンボボックスの設定
        comboBox.Items.Add("全て"); // 全てのデータを表示
        comboBox.Items.Add("カテゴリA"); // カテゴリA
        comboBox.Items.Add("カテゴリB"); // カテゴリB
        comboBox.SelectedIndexChanged += ComboBox_SelectedIndexChanged; // 選択が変更されたときのイベント
        this.Controls.Add(comboBox);
    }
    private void ComboBox_SelectedIndexChanged(object sender, EventArgs e)
    {
        // コンボボックスの選択に基づいてフィルタリング
        if (comboBox.SelectedItem.ToString() == "全て")
        {
            bindingSource.RemoveFilter(); // フィルタを解除
        }
        else
        {
            bindingSource.Filter = $"Category = '{comboBox.SelectedItem}'"; // 選択されたカテゴリのデータを表示
        }
    }
}

このコードでは、コンボボックスの選択に応じてBindingSourceのFilterプロパティが更新され、選択されたカテゴリに基づいてデータがフィルタリングされます。

これにより、ユーザーは特定のカテゴリのデータを簡単に表示できます。

応用例

フィルタリングとソートの組み合わせ

BindingSourceを使用すると、フィルタリングとソートを組み合わせてデータを表示することができます。

これにより、特定の条件に合ったデータを絞り込み、さらにその結果を特定の順序で表示することが可能です。

以下は、年齢が30歳以上のデータを年齢の降順で表示する例です。

partial class MyForm : Form
{
    private BindingSource bindingSource = new BindingSource();
    private DataGridView dataGridView = new DataGridView();
    public MyForm()
    {
        InitializeComponent();
        
        // データソースの設定
        bindingSource.DataSource = GetData(); // GetData()はデータを取得するメソッド
        
        // DataGridViewの設定
        dataGridView.DataSource = bindingSource;
        this.Controls.Add(dataGridView);
        
        // フィルタ条件の設定
        bindingSource.Filter = "Age >= 30"; // 年齢が30歳以上のデータを表示
        
        // ソート条件の設定
        bindingSource.Sort = "Age DESC"; // 年齢の降順でソート
    }
}

このコードでは、年齢が30歳以上のデータをフィルタリングし、さらに年齢の降順で表示しています。

これにより、ユーザーは条件に合ったデータを簡単に確認できます。

フィルタリング結果のカウント表示

フィルタリングした結果の件数を表示することも可能です。

これにより、ユーザーはフィルタリングの結果がどれだけのデータを含んでいるかを把握できます。

以下は、フィルタリング結果の件数を表示する例です。

partial class MyForm : Form
{
    private BindingSource bindingSource = new BindingSource();
    private Label countLabel = new Label();
    public MyForm()
    {
        InitializeComponent();
        
        // データソースの設定
        bindingSource.DataSource = GetData(); // GetData()はデータを取得するメソッド
        
        // フィルタ条件の設定
        bindingSource.Filter = "Age >= 30"; // 年齢が30歳以上のデータを表示
        
        // フィルタリング結果の件数を表示
        countLabel.Text = $"フィルタリング結果の件数: {bindingSource.Count}"; // 件数を表示
        this.Controls.Add(countLabel);
    }
}

このコードでは、フィルタリング条件に基づいて表示されるデータの件数をLabelに表示しています。

これにより、ユーザーはフィルタリングの結果を簡単に確認できます。

フィルタリング条件の動的変更

ユーザーの操作に応じてフィルタリング条件を動的に変更することも可能です。

例えば、複数のテキストボックスを使用して、異なる条件でフィルタリングを行うことができます。

以下は、名前と年齢の両方でフィルタリングを行う例です。

partial class MyForm : Form
{
    private BindingSource bindingSource = new BindingSource();
    private TextBox nameTextBox = new TextBox();
    private TextBox ageTextBox = new TextBox();
    public MyForm()
    {
        InitializeComponent();
        
        // データソースの設定
        bindingSource.DataSource = GetData(); // GetData()はデータを取得するメソッド
        
        // テキストボックスの設定
        nameTextBox.TextChanged += FilterData; // 名前のテキストボックス
        ageTextBox.TextChanged += FilterData; // 年齢のテキストボックス
        this.Controls.Add(nameTextBox);
        this.Controls.Add(ageTextBox);
    }
    private void FilterData(object sender, EventArgs e)
    {
        // フィルタ条件の動的変更
        string nameFilter = string.IsNullOrEmpty(nameTextBox.Text) ? "" : $"Name LIKE '{nameTextBox.Text}%'";
        string ageFilter = string.IsNullOrEmpty(ageTextBox.Text) ? "" : $"Age >= {ageTextBox.Text}";
        
        // フィルタ条件を組み合わせる
        if (!string.IsNullOrEmpty(nameFilter) && !string.IsNullOrEmpty(ageFilter))
        {
            bindingSource.Filter = $"{nameFilter} AND {ageFilter}"; // 両方の条件を適用
        }
        else if (!string.IsNullOrEmpty(nameFilter))
        {
            bindingSource.Filter = nameFilter; // 名前の条件のみ
        }
        else if (!string.IsNullOrEmpty(ageFilter))
        {
            bindingSource.Filter = ageFilter; // 年齢の条件のみ
        }
        else
        {
            bindingSource.RemoveFilter(); // フィルタを解除
        }
    }
}

このコードでは、名前と年齢のテキストボックスの内容に基づいてフィルタリング条件が動的に変更されます。

ユーザーが入力するたびに、表示されるデータが更新されるため、柔軟なデータ表示が可能です。