【C#】dataGridViewのソート時にチェックボックス列のチェック状態を保持するには

この記事では、dataGridViewのソート時にチェックボックス列のチェック状態を保持する方法についてご説明します。

【動画】dataGridViewのソート時にチェックボックス列のチェック状態を保持する実際の動き

本題に入る前に、まずは次の動画をご覧ください。


dataGridView用のデータテーブルにチェックボックスの状態を保存するための新たな列を追加することで、dataGridViewのソート時にチェックボックス列のチェック状態を保持しています。

コードの流れ

STEP.1
dataGridView用のデータテーブルに、チェックボックスの状態を保存するための新たな列を追加する
dataGridView用のデータテーブルに、チェックボックスの状態を保存するための新たな列を追加します。
STEP.2
チェックボックスの列を表示させる
チェックボックスの列を表示させます。

dataGridViewの出力例

今回は次のdataGridViewを用意しました。

dataGridViewの一番左にチェックボックス列が表示されています。

このチェックボックス列のチェックボックスに任意でチェックを付けます。

今回は項番が4と6のデータのチェックボックスにチェックを付けました。

以上の状態で「項番」の列のヘッダをクリックしてソートすると下のとおりに表示されます。

並び順がソートされても、項番が4と6のデータのチェックボックスにチェックがついたままで表示されています。

再度「項番」の列のヘッダをクリックしてソートすると下のとおりに表示されます。

再度並び順がソートされても、項番が4と6のデータのチェックボックスにチェックがついたままで表示されています。

C#のコード(例)

App.configのコード

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.2" />
    </startup>
    <appSettings>
        <!-- 接続文字列 -->
        <add key="DBConnString" value="Provider=Microsoft.Jet.OLEDB.4.0;Data Source={0}" />

        <!-- Accessのデータベースファイルのパス -->
        <add key="DBPath" value="C:\work\10_勉強\21_C#\0050\0050.mdb" />

    </appSettings>
</configuration>

注目すべきコード①

最初に見て頂きたいのは8行目と11行目です。

今回はAccessのテーブルデータを使います。

8行目は、Accessのデータベースファイルに接続するのに必要な接続文字列を「DBConnString」というキーに設定しているコードです。

11行目は、Accessのデータベースファイルのパスを「DBPath」というキーに設定しているコードです。

「DBConnString」と「DBPath」のキーの値をフォーム側のコードが参照して使います。

フォームのコード

using System;
using System.Windows.Forms;
using System.Data;
using System.Data.OleDb;
using System.Configuration;

namespace wfcs_0050
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        void Form1_Load(object sender, EventArgs e)
        {
            // DataGridViewのデータソースをnullに設定して表示されているデータをクリアする
            dataGridView1.DataSource = null;

            // DataGridViewの列をクリアして表示されている列を削除する
            dataGridView1.Columns.Clear();

            // App.configのappSettingsタグ内に記述した「DBConnString」のキーの値を取得して変数「connStrTemplate」に格納する
            string connStrTemplate = ConfigurationManager.AppSettings["DBConnString"];

            // App.configのappSettingsタグ内に記述した「DBPath」のキーの値を取得して変数「dbPathStr」に格納する
            string dbPathStr = ConfigurationManager.AppSettings["DBPath"];

            // connStrTemplateの{0}の部分を、「dbPathStr」の値に置き換える
            string connectionString = string.Format(connStrTemplate, dbPathStr);

            // OleDbConnectionインスタンスを生成する
            using (OleDbConnection connection = new OleDbConnection(connectionString))
            {
                // Accessのデータベースファイルに接続する
                connection.Open();

                // SQLクエリを作成します
                string query = "SELECT * FROM t_item";

                // OleDbCommandインスタンスを生成する
                using (OleDbCommand command = new OleDbCommand(query, connection))
                {
                    // OleDbDataAdapterインスタンスを生成する
                    using (OleDbDataAdapter adapter = new OleDbDataAdapter(command))
                    {
                        // DataTableインスタンスを生成する
                        DataTable dt = new DataTable();

                        // データテーブルにデータを格納する
                        adapter.Fill(dt);

                        // データテーブルに、チェックボックスの状態を保存するための新たな列を追加する
                        dt.Columns.Add("チェック", typeof(bool));

                        // DataGridViewにデータを表示する
                        this.dataGridView1.DataSource = dt;
                    }
                }

                // Accessのデータベースファイルの接続を閉じる
                connection.Close();
            }

            // チェックボックスの列の表示位置を列の1列目(インデックスが0)に設定する
            dataGridView1.Columns["チェック"].DisplayIndex = 0;
        }
    }
}

注目すべきコード①

最初に見て頂きたいのは3行目から5行目です。

using System.Data;
using System.Data.OleDb;
using System.Configuration;

3行目の「using System.Data」はDataTableクラスを扱うのに必要な名前空間です。

DataTableクラスからインスタンスを生成し、取得したAccessのテーブルデータを格納することができます。

4行目の「using System.Data」はOleDbConnectionクラスを使うのに必要な名前空間です。

OleDbConnectionクラスからインスタンスを生成し、OleDbConnectionインスタンスのOpenメソッドを実行することでAccessのデータベースに接続することができます。

5行目の「using System.Configuration」はConfigurationManagerクラスを使うのに必要な名前空間です。

ConfigurationManagerクラスからインスタンスを生成し、ConfigurationManagerのインスタンスのAppSettingsプロパティに「App.config」のキーを指定することで、「App.config」からキーの値を取得することができます。

例えば、以下の22行目のコードの場合、AppSettingsプロパティに「DBPath」を指定しています。

            string dbPathStr = ConfigurationManager.AppSettings["DBPath"];

この「DBPath」はApp.configの「DBPath」のキーを指します。

		

AppSettingsプロパティに「DBPath」を指定しているので、変数「dbPathStr」には「C:\work\10_勉強\21_C#\0050\0050.mdb”」が格納されます。

注目すべきコード②

次に見て頂きたいのは19行目から22行目です。

            // DataGridViewのデータソースをnullに設定して表示されているデータをクリアする
            dataGridView1.DataSource = null;

            // DataGridViewの列をクリアして表示されている列を削除する
            dataGridView1.Columns.Clear();

コードの説明

以上のコードは、datagridviewの表示をクリアする処理のコードです。

19行目でDataSourceにnullを設定することで表示されているデータをクリアし、22行目のClearメソッドを実行することで表示されている列を削除します。

以上の2行のコードを実行することでdatagridviewの表示がクリアされます。

注目すべきコード③

次に見て頂きたいのは25行目から28行目です。

            // App.configのappSettingsタグ内に記述した「DBConnString」のキーの値を取得して変数「connStrTemplate」に格納する
            string connStrTemplate = ConfigurationManager.AppSettings["DBConnString"];

            // App.configのappSettingsタグ内に記述した「DBPath」のキーの値を取得して変数「dbPathStr」に格納する
            string dbPathStr = ConfigurationManager.AppSettings["DBPath"];

コードの説明

以上のコードは、App.configのappSettingsタグ内に記述した「DBConnString」「DBPath」のキーの値を取得して変数に格納するコードです。

「DBConnString」のキーの値は変数「connStrTemplate」に、「DBPath」のキーの値は変数「dbPathStr」に格納します。

注目すべきコード④

次に見て頂きたいのは31行目です。

            // connStrTemplateの{0}の部分を、「dbPathStr」の値に置き換える
            string connectionString = string.Format(connStrTemplate, dbPathStr);

コードの説明

以上のコードは、connStrTemplateの{0}の部分を、「dbPathStr」の値に置き換える処理のコードです。

connStrTemplateの{0}の部分を、「dbPathStr」の値に置き換える、とはどういうことかというと、{0}の部分をAccessのデータベースファイルのフルパスに置き換える、ということです。

今回は接続文字列と、Accessのデータベースのフルパスを分けてそれぞれ「DBConnString」と「DBPath」とキーを分けてあるので、フォームのコード側で接続文字列と、Accessのデータベースのフルパスを一つの文字列に組み立てています。

参考までに、string.Format実行前と実行後の状態を以下にお見せします。

以上のように、{0}の部分が「C:\work\10_勉強\21_C#\0050\0050.mdb」に置き換わっています。

参考:string.Format実行前

Provider=Microsoft.Jet.OLEDB.4.0;Data Source={0}

参考:string.Format実行後

Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\work\10_勉強\21_C#\0050\0050.mdb

注目すべきコード⑤

次に見て頂きたいのは34行目から37行目です。

            // OleDbConnectionインスタンスを生成する
            using (OleDbConnection connection = new OleDbConnection(connectionString))
            {
                // Accessのデータベースファイルに接続する
                connection.Open();

コードの説明

以上のコードは、OleDbConnectionオブジェクトを作成し、Accessのデータベースファイル接続している処理のコードです。

コードの詳細

34行目のコードでは、App.configから取得したAccessのデータベースファイルの接続情報(connectionString)を元にOleDbConnectionインスタンスを作成しています。

37行目のコードでは、生成したOleDbConnectionインスタンスのOpenメソッドを実行してAccessのデータベースファイルに接続しています。

注目すべきコード⑥

次に見て頂きたいのは40行目から67行目です。

                // SQLクエリを作成します
                string query = "SELECT * FROM t_syain";

                // OleDbCommandインスタンスを生成する
                using (OleDbCommand command = new OleDbCommand(query, connection))
                {
                    // OleDbDataAdapterインスタンスを生成する
                    using (OleDbDataAdapter adapter = new OleDbDataAdapter(command))
                    {
                        // DataTableインスタンスを生成する
                        DataTable dt = new DataTable();

                        // データテーブルにデータを格納する
                        adapter.Fill(dt);

                        // データテーブルに、チェックボックスの状態を保存するための新たな列を追加する
                        dt.Columns.Add("チェック", typeof(bool));

                        // DataGridViewにデータを表示する
                        this.dataGridView1.DataSource = dt;
                    }
                }

                // Accessのデータベースファイルの接続を閉じる
                connection.Close();
            }

            // チェックボックスの列の表示位置を列の1列目(インデックスが0)に設定する
            dataGridView1.Columns["チェック"].DisplayIndex = 0;

コードの説明

以上のコードは、Accessのテーブルデータを取得するSELECT文を用意して実行し、取得したAccessのテーブルデータをdataGridViewに表示する処理のコードです。

続けてAccessのデータベースファイルの接続を閉じています。

また、AccessのテーブルデータをdataGridView用のデータテーブル(DataTable)に追加するだけでなく、さらにチェックボックス用の列もデータテーブルに追加しています。

チェックボックス用の列をデータテーブルに追加することで、dataGridViewのソート時にチェックボックス列のチェックボックスのチェック状態を保持することができます。

チェックボックス用の列もデータテーブルに追加しないと、チェックボックス列のチェックボックスにチェックを付けても、dataGridViewのソート時にチェックが全解除されてしまいます。

データテーブルにチェックボックス用の列を追加せずにソートした時の挙動

チェックボックスにチェックを付けて「項番」のヘッダをクリックする

「項番」の列でソートが行われたが、チェックボックスがすべて外れてしまう

コードの詳細

40行目のコードでは、Accessのテーブルデータを取得するSELECT文を用意しています。

43行目のコードでは、SELECT文を実行するために、SELECT文とOleDbConnectionインスタンス(connection)を指定してOleDbCommandクラスからインスタンスを生成します。

46行目のコードでは、OleDbDataAdapterインスタンスを生成し、SELECT文を関連付けます。

OleDbDataAdapterインスタンスが生成されたことで、SELECT文を実行することができるようになります。

49行目のコードでは、SELECT文を実行して取得したデータを格納するのに必要なDataTableのインスタンス「dt」を生成します。

52行目のコードでは、Fillメソッドを実行するとSELECT文が実行されて、取得したデータが「dt」に格納されます。

55行目のコードでは、データテーブルに、チェックボックスの状態を保存するための新たな列を追加します。

このコードにより、チェックボックスの状態がデータテーブルに保存されるため、dataGridViewのソート時にチェックボックス列のチェック状態が解除されずに保持することができます。

Addメソッドにチェックボックス列のヘッダの文言と列の型を指定します。

今回はチェックボックスボックス列のヘッダの文言に「チェック」の文字列を指定しています。

また、チェックボックスのチェックのチェック状態はbool型なので「typeof(bool)」を指定しています。

58行目のコードでは、取得したAccessのテーブルデータをdataGridViewに表示させます。

63行目のコードでは、Accessのデータベースファイルの接続を閉じています。

67行目のコードでは、チェックボックスを表示する列を追加する処理のコードです。

DisplayIndexプロパティに0を設定すると、チェックボックス列はdatagridviewの1番左の列に表示されます。

動作確認

「dataGridViewの出力例」をご覧ください。

【注意】参照設定が必要です

一つ注意点があるのですが、先ほどのコードを動かすには参照設定が必要です。

「System.Configuration」の項目を追加しないと、「ConfigurationManager」が存在しないとのことでエラーになってしまいます。

本コードを実行する際は、「System.Configuration」の項目を追加しましょう。

最後に

この記事では、dataGridViewのソート時にチェックボックス列のチェック状態を保持する方法についてご説明しました。

dataGridViewのソート時にチェックボックス列のチェックが外れてしまう場合は本記事を参考にしてみてくださいね。

プログラミングのスキルを習得するなら

プログラミングのスキルを習得したい、今のスキルをもっと高めたい、そう考えているなら「プログラミングスクール」がおすすめです。

プログラミングのスキルの基礎を身につけるなら「TechAcademy」で1週間の無料体験があるので、これで「プログラミングの基礎」を学ぶのにおすすめですよ。

→ TechAcademyの「1週間 無料体験」はこちら