【VB.NET】DataGridViewコントロールでチェックボックスの状態を取得するには？

訪問して頂きありがとうございます。まさふくろーです。

この記事では、DataGridViewコントロールでチェックボックスの状態を取得する方法をご紹介します。

DataGridViewコントロールでチェックボックスの状態を取得する
- サンプルプログラム（単一行）
  - DataGridViewに表示する処理
  - DataGridViewのチェックボックスの状態を取得する処理
- サンプルプログラム（複数行）
  - DataGridViewに表示する処理
  - DataGridViewのチェックボックスの状態を取得する処理
関連記事

DataGridViewコントロールでチェックボックスの状態を取得する

DataGridViewコントロールで選択されている行の値を取得するには、DataGridViewRowオブジェクトのCurrentRowプロパティを使います。
選択している行から、各セルの値を取得するには、DataGridViewCellオブジェクトのValueプロパティを使います。
DataGridViewCellオブジェクトは、DataGridViewRowオブジェクトのCellsプロパティから取得します。
チェックボックスにチェックが付いている場合は「True」、チェックが付いていない場合は「False」を返します。
書式は、以下になります。

DataGridView.CurrentRow.Cells(列のインデックス).Value

DataGridViewコントロールに表示されているすべての行の値を取得するには、DataGridViewRowオブジェクトのRowsプロパティを使います。
各セルの値を取得するには、DataGridViewCellオブジェクトのValueプロパティを使います。
DataGridViewCellオブジェクトは、DataGridViewRowオブジェクトのCellsプロパティから取得します。
チェックボックスにチェックが付いている場合は「True」、チェックが付いていない場合は「False」を返します。
書式は、以下になります。

DataGridView.Rows(行番号).Cells(列のインデックス).Value

列のインデックスは、DataGridViewコントロールの左から順番に「0、1、2・・・」と割り振られます。

サンプルプログラム（単一行）

DataGridViewに表示する処理

Public Class Form1
    Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click

        Dim serverName As String = "TEST-PC\SQLEXPRESS"
        Dim dataBase As String = "AdventureWorksLT2017"
        Dim userid As String = "test"
        Dim pwd As String = "test"
        Dim dread As SqlClient.SqlDataReader
        Dim str As String = String.Empty

        Try

            Using conn As New SqlClient.SqlConnection()

                conn.ConnectionString =
                    " Data Source = " & serverName &
                    ";Initial Catalog = " & dataBase &
                    ";User ID = " & userid &
                    ";Password =" & pwd

                conn.Open()

                Using cmd As New SqlClient.SqlCommand()

                    cmd.Connection = conn

                    cmd.CommandText =
                            "SELECT *                                                           " & ControlChars.NewLine &
                            "FROM  SalesLT.SalesOrderHeader                                     " & ControlChars.NewLine &
                            "WHERE SalesOrderID BETWEEN @SalesOrderID_St AND @SalesOrderID_End  " & ControlChars.NewLine &
                            "ORDER BY  SalesOrderID                                             " & ControlChars.NewLine

                    cmd.Parameters.Add("@SalesOrderID_St", SqlDbType.Int).Value = 71774
                    cmd.Parameters.Add("@SalesOrderID_End", SqlDbType.Int).Value = 71816

                    dread = cmd.ExecuteReader()

                    Do While dread.Read()

                        Dim iIdx As Integer
                        Dim SalesOrder_ID As String, Order_Date As String, Due_Date As String, SalesOrder_Number As String

                        iIdx = dread.GetOrdinal("SalesOrderID")
                        SalesOrder_ID = dread.GetInt32(iIdx)

                        iIdx = dread.GetOrdinal("OrderDate")
                        Order_Date = dread.GetDateTime(iIdx)

                        iIdx = dread.GetOrdinal("DueDate")
                        Due_Date = dread.GetDateTime(iIdx)

                        iIdx = dread.GetOrdinal("SalesOrderNumber")
                        SalesOrder_Number = dread.GetString(iIdx)

                        DataGridView1.Rows.Add(False, SalesOrder_ID, Order_Date, Due_Date, SalesOrder_Number)

                    Loop

                End Using

                DataGridView1.Columns(0).Width = 50

                Label1.Text = "表示が完了しました。"

            End Using

        Catch ex As Exception

            Label1.Text = Err.Description

        End Try

    End Sub
End Class

Public Class Form1

Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click

Dim serverName As String = "TEST-PC\SQLEXPRESS"

Dim dataBase As String = "AdventureWorksLT2017"

Dim userid As String = "test"

Dim pwd As String = "test"

Dim dread As SqlClient.SqlDataReader

Dim str As String = String.Empty

Try

Using conn As New SqlClient.SqlConnection()

conn.ConnectionString =

" Data Source = " & serverName &

";Initial Catalog = " & dataBase &

";User ID = " & userid &

";Password =" & pwd

conn.Open()

Using cmd As New SqlClient.SqlCommand()

cmd.Connection = conn

cmd.CommandText =

"SELECT * " & ControlChars.NewLine &

"FROM SalesLT.SalesOrderHeader " & ControlChars.NewLine &

"WHERE SalesOrderID BETWEEN @SalesOrderID_St AND @SalesOrderID_End " & ControlChars.NewLine &

"ORDER BY SalesOrderID " & ControlChars.NewLine

cmd.Parameters.Add("@SalesOrderID_St", SqlDbType.Int).Value = 71774

cmd.Parameters.Add("@SalesOrderID_End", SqlDbType.Int).Value = 71816

dread = cmd.ExecuteReader()

Do While dread.Read()

Dim iIdx As Integer

Dim SalesOrder_ID As String, Order_Date As String, Due_Date As String, SalesOrder_Number As String

iIdx = dread.GetOrdinal("SalesOrderID")

SalesOrder_ID = dread.GetInt32(iIdx)

iIdx = dread.GetOrdinal("OrderDate")

Order_Date = dread.GetDateTime(iIdx)

iIdx = dread.GetOrdinal("DueDate")

Due_Date = dread.GetDateTime(iIdx)

iIdx = dread.GetOrdinal("SalesOrderNumber")

SalesOrder_Number = dread.GetString(iIdx)

DataGridView1.Rows.Add(False, SalesOrder_ID, Order_Date, Due_Date, SalesOrder_Number)

Loop

End Using

DataGridView1.Columns(0).Width = 50

Label1.Text = "表示が完了しました。"

End Using

Catch ex As Exception

Label1.Text = Err.Description

End Try

End Sub

End Class

2	「注文データを表示」ボタンクリック時に以下処理を行う。
4～7	接続先データベースの情報を、変数に代入。
13	SqlConnectionクラスのインスタンス化。（Usingステートメントでリソース開放を自動化）
15～19	ConnectionStringプロパティにデータベース情報を設定。
21	データベースに接続。
23	SqlCommandクラスのインスタンス化。（Usingステートメントでリソース開放を自動化）
25	SQL文を実行するために、15～19行目で設定したデータベース情報と同じ情報をConnection プロパティに設定。
27～31	レコードを抽出するSQL文をCommandTextプロパティに設定。
27～31	30行目の「@」マークは、以下33～34行目で設定するパラメータを使用する際に記述します。
33	「SalesOrderHeader」テーブルの「SalesOrderID」列の開始番号に、値「71774」を設定する。
34	「SalesOrderHeader」テーブルの「SalesOrderID」列の終了番号に、値「71816」を設定する。
36	SQL文（SalesOrderID列の値が71774～71816までのレコードを抽出する）を実行し、実行結果をSqlDataReader型の変数「dread」に代入。
38	変数「dread」の値が「True」の間（抽出したレコード件数分）、以下処理を繰り返す。
43	「SalesOrderID」列の列番号を取得し、Integer型の変数「iIdx」に代入。
44	「SalesOrderID」列の値を取得し、String型の変数「SalesOrder_ID」に代入。
46	「OrderDate」列の列番号を取得し、Integer型の変数「iIdx」に代入。
47	「OrderDate」列の値を取得し、String型の変数「Order_Date」に代入。
49	「DueDate」列の列番号を取得し、Integer型の変数「iIdx」に代入。
50	「DueDate」列の値を取得し、String型の変数「Due_Date」に代入。
52	「SalesOrderNumber」列の列番号を取得し、Integer型の変数「iIdx」に代入。
53	「SalesOrderNumber」列の値を取得し、String型の変数「SalesOrder_Number」に代入。
55	DataGridViewコントロールにデータを表示する。（チェックボックスはチェックを付けないように「False」を設定）
61	DataGridViewコントロールの１列目（チェックボックス）の幅を50ピクセルにする。
63	処理が正常に終了したら、正常終了のメッセージをラベルに表示する。
67	処理の実行中にエラーが発生した場合、
69	エラー内容を取得し、ラベルに表示する。

DataGridViewのチェックボックスの状態を取得する処理

Public Class Form1
    Private Sub Button2_Click(sender As Object, e As EventArgs) Handles Button2.Click

        Dim CheckStatus As Boolean

        Try

            CheckStatus = DataGridView1.CurrentRow.Cells(0).Value

            If CheckStatus = True Then

                Label1.Text = "チェックあり"

            Else

                Label1.Text = "チェックなし"

            End If

        Catch ex As Exception

            Label1.Text = Err.Description

        End Try

    End Sub
End Class

Public Class Form1

Private Sub Button2_Click(sender As Object, e As EventArgs) Handles Button2.Click

Dim CheckStatus As Boolean

Try

CheckStatus = DataGridView1.CurrentRow.Cells(0).Value

If CheckStatus = True Then

Label1.Text = "チェックあり"

Else

Label1.Text = "チェックなし"

End If

Catch ex As Exception

Label1.Text = Err.Description

End Try

End Sub

End Class

2	「DataGridViewのチェックボックスの状態を取得」ボタンクリック時に以下処理を行う。
8	DataGridViewの選択行の１列目（チェックボックス）の状態を取得し、Boolean型の変数「CheckStatus」に代入。
10	取得した値が「True」の場合、
12	文字列「チェックあり」をラベルに表示する。
14	取得した値が「False」の場合、
16	文字列「チェックなし」をラベルに表示する。
20	処理の実行中にエラーが発生した場合、
22	エラー内容を取得し、ラベルに表示する。

サンプルプログラム（複数行）

DataGridViewに表示する処理

Public Class Form1
    Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click

        Dim serverName As String = "TEST-PC\SQLEXPRESS"
        Dim dataBase As String = "AdventureWorksLT2017"
        Dim userid As String = "test"
        Dim pwd As String = "test"
        Dim dread As SqlClient.SqlDataReader
        Dim str As String = String.Empty

        Try

            Using conn As New SqlClient.SqlConnection()

                conn.ConnectionString =
                    " Data Source = " & serverName &
                    ";Initial Catalog = " & dataBase &
                    ";User ID = " & userid &
                    ";Password =" & pwd

                conn.Open()

                Using cmd As New SqlClient.SqlCommand()

                    cmd.Connection = conn

                    cmd.CommandText =
                            "SELECT *                                                           " & ControlChars.NewLine &
                            "FROM  SalesLT.SalesOrderHeader                                     " & ControlChars.NewLine &
                            "WHERE SalesOrderID BETWEEN @SalesOrderID_St AND @SalesOrderID_End  " & ControlChars.NewLine &
                            "ORDER BY  SalesOrderID                                             " & ControlChars.NewLine

                    cmd.Parameters.Add("@SalesOrderID_St", SqlDbType.Int).Value = 71774
                    cmd.Parameters.Add("@SalesOrderID_End", SqlDbType.Int).Value = 71816

                    dread = cmd.ExecuteReader()

                    Do While dread.Read()

                        Dim iIdx As Integer
                        Dim SalesOrder_ID As String, Order_Date As String, Due_Date As String, SalesOrder_Number As String

                        iIdx = dread.GetOrdinal("SalesOrderID")
                        SalesOrder_ID = dread.GetInt32(iIdx)

                        iIdx = dread.GetOrdinal("OrderDate")
                        Order_Date = dread.GetDateTime(iIdx)

                        iIdx = dread.GetOrdinal("DueDate")
                        Due_Date = dread.GetDateTime(iIdx)

                        iIdx = dread.GetOrdinal("SalesOrderNumber")
                        SalesOrder_Number = dread.GetString(iIdx)

                        DataGridView1.Rows.Add(False, SalesOrder_ID, Order_Date, Due_Date, SalesOrder_Number)

                    Loop

                End Using

                DataGridView1.Columns(0).Width = 50

                Label1.Text = "表示が完了しました。"

            End Using

        Catch ex As Exception

            Label1.Text = Err.Description

        End Try

    End Sub
End Class

Public Class Form1

Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click

Dim serverName As String = "TEST-PC\SQLEXPRESS"

Dim dataBase As String = "AdventureWorksLT2017"

Dim userid As String = "test"

Dim pwd As String = "test"

Dim dread As SqlClient.SqlDataReader

Dim str As String = String.Empty

Try

Using conn As New SqlClient.SqlConnection()

conn.ConnectionString =

" Data Source = " & serverName &

";Initial Catalog = " & dataBase &

";User ID = " & userid &

";Password =" & pwd

conn.Open()

Using cmd As New SqlClient.SqlCommand()

cmd.Connection = conn

cmd.CommandText =

"SELECT * " & ControlChars.NewLine &

"FROM SalesLT.SalesOrderHeader " & ControlChars.NewLine &

"WHERE SalesOrderID BETWEEN @SalesOrderID_St AND @SalesOrderID_End " & ControlChars.NewLine &

"ORDER BY SalesOrderID " & ControlChars.NewLine

cmd.Parameters.Add("@SalesOrderID_St", SqlDbType.Int).Value = 71774

cmd.Parameters.Add("@SalesOrderID_End", SqlDbType.Int).Value = 71816

dread = cmd.ExecuteReader()

Do While dread.Read()

Dim iIdx As Integer

Dim SalesOrder_ID As String, Order_Date As String, Due_Date As String, SalesOrder_Number As String

iIdx = dread.GetOrdinal("SalesOrderID")

SalesOrder_ID = dread.GetInt32(iIdx)

iIdx = dread.GetOrdinal("OrderDate")

Order_Date = dread.GetDateTime(iIdx)

iIdx = dread.GetOrdinal("DueDate")

Due_Date = dread.GetDateTime(iIdx)

iIdx = dread.GetOrdinal("SalesOrderNumber")

SalesOrder_Number = dread.GetString(iIdx)

DataGridView1.Rows.Add(False, SalesOrder_ID, Order_Date, Due_Date, SalesOrder_Number)

Loop

End Using

DataGridView1.Columns(0).Width = 50

Label1.Text = "表示が完了しました。"

End Using

Catch ex As Exception

Label1.Text = Err.Description

End Try

End Sub

End Class

2	「注文データを表示」ボタンクリック時に以下処理を行う。
4～7	接続先データベースの情報を、変数に代入。
13	SqlConnectionクラスのインスタンス化。（Usingステートメントでリソース開放を自動化）
15～19	ConnectionStringプロパティにデータベース情報を設定。
21	データベースに接続。
23	SqlCommandクラスのインスタンス化。（Usingステートメントでリソース開放を自動化）
25	SQL文を実行するために、15～19行目で設定したデータベース情報と同じ情報をConnection プロパティに設定。
27～31	レコードを抽出するSQL文をCommandTextプロパティに設定。
27～31	30行目の「@」マークは、以下33～34行目で設定するパラメータを使用する際に記述します。
33	「SalesOrderHeader」テーブルの「SalesOrderID」列の開始番号に、値「71774」を設定する。
34	「SalesOrderHeader」テーブルの「SalesOrderID」列の終了番号に、値「71816」を設定する。
36	SQL文（SalesOrderID列の値が71774～71816までのレコードを抽出する）を実行し、実行結果をSqlDataReader型の変数「dread」に代入。
38	変数「dread」の値が「True」の間（抽出したレコード件数分）、以下処理を繰り返す。
43	「SalesOrderID」列の列番号を取得し、Integer型の変数「iIdx」に代入。
44	「SalesOrderID」列の値を取得し、String型の変数「SalesOrder_ID」に代入。
46	「OrderDate」列の列番号を取得し、Integer型の変数「iIdx」に代入。
47	「OrderDate」列の値を取得し、String型の変数「Order_Date」に代入。
49	「DueDate」列の列番号を取得し、Integer型の変数「iIdx」に代入。
50	「DueDate」列の値を取得し、String型の変数「Due_Date」に代入。
52	「SalesOrderNumber」列の列番号を取得し、Integer型の変数「iIdx」に代入。
53	「SalesOrderNumber」列の値を取得し、String型の変数「SalesOrder_Number」に代入。
55	DataGridViewコントロールにデータを表示する。（チェックボックスはチェックを付けないように「False」を設定）
61	DataGridViewコントロールの１列目（チェックボックス）の幅を50ピクセルにする。
63	処理が正常に終了したら、正常終了のメッセージをラベルに表示する。
67	処理の実行中にエラーが発生した場合、
69	エラー内容を取得し、ラベルに表示する。

DataGridViewのチェックボックスの状態を取得する処理

Public Class Form1
    Private Sub Button2_Click(sender As Object, e As EventArgs) Handles Button2.Click

        Dim CheckStatus As Boolean 
        Dim dgvRowCnt As Integer 
        Dim i As Integer 
        Dim str As String = String.Empty 

        Try


            dgvRowCnt = DataGridView1.Rows.Count

            For i = 0 To dgvRowCnt - 1

                CheckStatus = DataGridView1.Rows(i).Cells(0).Value

                If CheckStatus = True Then

                    str &= i + 1 & "行目" & Space(2)

                End If

            Next

            Label1.Text = "チェック済みは、" & ControlChars.NewLine & str & ControlChars.NewLine & "です。"

        Catch ex As Exception

            Label1.Text = Err.Description

        End Try

    End Sub
End Class

Public Class Form1

Private Sub Button2_Click(sender As Object, e As EventArgs) Handles Button2.Click

Dim CheckStatus As Boolean

Dim dgvRowCnt As Integer

Dim i As Integer

Dim str As String = String.Empty

Try

dgvRowCnt = DataGridView1.Rows.Count

For i = 0 To dgvRowCnt - 1

CheckStatus = DataGridView1.Rows(i).Cells(0).Value

If CheckStatus = True Then

str &= i + 1 & "行目" & Space(2)

End If

Label1.Text = "チェック済みは、" & ControlChars.NewLine & str & ControlChars.NewLine & "です。"

Catch ex As Exception

Label1.Text = Err.Description

End Try

End Sub

End Class

2	「DataGridViewのチェックボックスの状態を取得」ボタンクリック時に以下処理を行う。
12	DataGridViewの行数を取得し、Integer型の変数「dgvRowCnt」に代入。
14	DataGridViewの行数分、以下処理を繰り返す。
16	チェックボックスの状態を取得し、Boolean型の変数「CheckStatus」に代入。
18	取得した値が「True」の場合、
20	DataGridViewの行数を、String型の変数「str」に追加していく。
26	処理が完了したら、チェックボックスにチェックが付いている行をラベルに表示する。
28	処理の実行中にエラーが発生した場合、
30	エラー内容を取得し、ラベルに表示する。