【C#】C#のdatagridviewにSQLiteのテーブルデータとボタンを表示させるには

この記事では、C#のdatagridviewにSQLiteのテーブルデータとボタンを表示させる方法についてご説明します。

【動画】C#のdatagridviewにSQLiteのテーブルデータとボタンを表示させる実際の動き

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

SQLiteConnectionインスタンスを生成し、SQLiteのデータベースに接続するのに必要な接続文字列を参照してSQLiteのデータベースに接続します。

SQLiteのデータベースに接続したら、SQLのSELECT文を実行してテーブルデータを取得します。

取得したテーブルデータをデータテーブルに格納してDataGridViewにデータを表示します。

datagridviewにデータを表示したら、ボタンを表示する列を追加します。

コードの流れ

SQLiteのデータベースに接続する前準備

C#からSQLiteのデータベースに接続するには、「System.Data.SQLite.Core」と呼ばれるパッケージが必要です。

「System.Data.SQLite.Core」を使うには、「System.Data.SQLite.Core」のインストールが必要なので、お使いの環境で「System.Data.SQLite.Core」がインストールされていない場合は下の内容をご参照ください。

フォームとSQLiteのテーブルデータの例

今回は次のフォームとSQLiteのテーブルデータを用意しました。

フォーム上には処理を開始する実行ボタンとSQLiteのテーブルデータを表示させるdataGridViewが設置されています。

dataGridViewには、以上のSQLiteのテーブルデータとボタンを表示させます。

DataGridViewに表示させた結果は下の通りです。

dataGridViewにSQLiteのテーブルデータとボタンが表示されています。

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="Data Source={0};Version=3" />

        <!-- 接続したいSQLiteのデータベースファイル名 -->
        <add key="DBPath" value="C:¥work¥10_勉強¥21_C#¥0026¥0026_DB01.db" />
    </appSettings>
</configuration>

コードの説明

以上のコードは、SQLiteのデータベースに接続するのに必要な接続文字列を「DBConnString」というキーに設定しているコードです。

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

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

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

ちなみに、今回接続しようとしているデータベースファイル「0026_DB01.db」は以下のフォルダに格納しています。

フォームのコード

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

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

        private void button1_Click(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」のキーの値を取得して変数「DBPath」に格納する
            string DBPath = ConfigurationManager.AppSettings["DBPath"];

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

            // SQLiteConnectionインスタンスを作成し、接続文字列を使用してデータベースに接続する
            using (SQLiteConnection connection = new SQLiteConnection(connectionString))
            {
                // 接続を開く
                connection.Open();

                // SELECT文を用意する
                string query = "select * from syain";

                // SQLiteDataAdapterインスタンスを生成する
                SQLiteDataAdapter adapter = new SQLiteDataAdapter(query, connection);

                // DataTableインスタンスを生成する
                DataTable dt = new DataTable();

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

                // DataGridViewにDataTableをバインドしてDataGridViewにデータを表示する
                dataGridView1.DataSource = dt;

                // データベース接続を閉じる
                connection.Close();
            }

            // DataGridViewButtonColumnのインスタンスを生成する
            DataGridViewButtonColumn column = new DataGridViewButtonColumn();

            // 列のヘッダの名前に「確認」の文字列を設定する
            column.Name = "確認";

            // ボタンに「詳細」のテキストを追加する
            column.Text = "詳細";

            // ボタンにテキストを表示させるように設定する
            column.UseColumnTextForButtonValue = true;

            // dataGridViewにボタンの列を追加する
            dataGridView1.Columns.Add(column);

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

注目すべきコード①

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

using System.Data.SQLite;

コードの説明

「System.Data.SQLite」は、C#からSQLiteのデータベースに接続するのに必要な名前空間です。

「System.Data.SQLite」は「SQLiteのデータベースに接続する前準備」の説明でお話したパッケージのことです。

C#からSQLiteへの接続にはこの「System.Data.SQLite」が必要になりますが、「SQLiteのデータベースに接続する前準備」の説明でお話した「System.Data.SQLite.Core」を事前にインストールをしておかないとエラーになります。

なので、忘れずに「System.Data.SQLite.Core」をインストールしておきましょう。

注目すべきコード②

次に見て頂きたいのは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」のキーの値を取得して変数「DBPath」に格納する
            string DBPath = ConfigurationManager.AppSettings["DBPath"];

コードの説明

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

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

注目すべきコード④

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

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

コードの説明

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

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

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

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

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

注目すべきコード⑤

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

            // SQLiteConnectionインスタンスを作成し、接続文字列を使用してデータベースに接続する
            using (SQLiteConnection connection = new SQLiteConnection(connectionString))
            {
                // 接続を開く
                connection.Open();

コードの説明

以上のコードは、SQLiteConnectionオブジェクトを作成し、SQLiteのデータベースに接続している処理のコードです。

以上のコードが正常に実行されれば、SQLiteのデータベースに接続されます。

注目すべきコード⑥

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

                // SELECT文を用意する
                string query = "select * from syain";

                // SQLiteDataAdapterインスタンスを生成する
                SQLiteDataAdapter adapter = new SQLiteDataAdapter(query, connection);

                // DataTableインスタンスを生成する
                DataTable dt = new DataTable();

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

                // DataGridViewにDataTableをバインドしてDataGridViewにデータを表示する
                dataGridView1.DataSource = dt;

コードの説明

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

コードの詳細

40行目のコードは、syainテーブルから値を取得するSELECT文です。

実際に取得するデータは下のとおりです。

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

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

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

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

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

注目すべきコード⑦

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

                // データベース接続を閉じる
                connection.Close();

コードの説明

以上のコードは、データベース接続を閉じる処理のコードです。

注目すべきコード⑧

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

            // DataGridViewButtonColumnのインスタンスを生成する
            DataGridViewButtonColumn column = new DataGridViewButtonColumn();

            // 列のヘッダの名前に「確認」の文字列を設定する
            column.Name = "確認";

            // ボタンに「詳細」のテキストを追加する
            column.Text = "詳細";

            // ボタンにテキストを表示させるように設定する
            column.UseColumnTextForButtonValue = true;

            // dataGridViewにボタンの列を追加する
            dataGridView1.Columns.Add(column);

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

コードの説明

以上のコードは、ボタンを表示する列を追加する処理のコードです。

コードの詳細

59行目のコードは、DataGridViewにボタン型のカラムを追加するためDataGridViewButtonColumnのインスタンスの生成を行います。

DataGridViewButtonColumnのインスタンスを生成することで、特定のセルにボタンを持つ列をDataGridViewに追加することができます。

62行目のコードは、列のヘッダの名前に「確認」の文字列を設定します。

65行目のコードは、ボタンに「詳細」のテキストを追加します。

68行目のコードは、65行目のコードで設定したボタンに設定したテキストを表示させる設定です。

UseColumnTextForButtonValueプロパティにFalseを設定する、またはこのコードを実行しない場合は、下の画像のとおりボタンにテキストが表示されません。

UseColumnTextForButtonValueプロパティにTrueを設定するのを忘れないようにしましょう。

71行目のコードは、datagridviewにボタン列を追加するコードです。

ここまで説明した59行目から71行目の設定を元に、datagridviewにボタン列を追加します。

74行目のコードでは、ボタン列を左から何番目に表示させるかを設定します。

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

DisplayIndexプロパティに1を設定した場合は2列目に表示されます。

動作確認

「フォームとSQLiteのテーブルデータの例」をご覧ください。

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

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

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

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

最後に

この記事では、C#のdatagridviewにSQLiteのテーブルデータとボタンを表示させる方法についてご説明します。

C#のdatagridviewにSQLiteのテーブルデータとボタンを表示したいときは本記事を参考にしてみてくださいね。

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

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

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

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