【実務・中級編】Windows FormsのDataGridViewにおけるセルのドラッグ＆ドロップ並び替え：BindingListを使った直感的な行順序変更の実装 – Visual Basic (VB / VB.NET)解析バイブル

Stop Manipulating Rows! Data-Centric Design for DataGridView Drag & Drop

業務アプリケーションの開発において、「ユーザーが直感的に操作できること」は、システムの価値を決定づける重要な要素だ。特にマスタメンテナンス画面において、行の並び替えをマウスドラッグで行わせる要望は、現場から頻繁に上がる。

しかし、多くの開発者がここで致命的なミスを犯す。「DataGridViewのRowコレクションを直接操作して、見た目だけを並び替えてしまう」のだ。

これは設計思想として完全に誤っている。UI（表示層）とデータ（論理層）のライフサイクルを混同した結果、データソースとの不整合、あるいは保存時にデータが元に戻る、あるいは最悪の場合はインデックスの不整合でアプリケーションがクラッシュするという、プロフェッショナルとしてはあってはならない事態を招く。

本稿では、伝説的なアーキテクトの視点から、BindingList(Of T) を核とした、堅牢で保守性の高い「データ駆動型」のドラッグ＆ドロップ実装を伝授する。

1. なぜ「Rowの操作」は破綻するのか

まず、初心者が陥る「間違った設計」を理解しておこう。

`DataGridView.Rows.RemoveAt()` や `Insert()` を使ってグリッドの見た目を操作する手法がある。これでは、グリッドがバインドしている元のリスト（`List(Of T)` など）は一切変化していない。そのため、ユーザーが並び替えた後に「保存」ボタンを押しても、データベースには元の順序で書き込まれる。あるいは、再描画（Refresh）が発生した瞬間に、並び替えの結果が消失する。

真に目指すべきは、「データソースの並び順を変え、それによってUIが自動的に追従する」設計である。

この「データの変更がUIへ波及する」メカニズムを実現するために不可欠なのが、`BindingList(Of T)` だ。

2. 堅牢な実装のための設計指針

実装に入る前に、アーキテクトとして以下の3点を約束せよ。

1. Data-Centric (データ中心主義): UI操作の目的は、常に「データソースの変更」であること。
2. Single Source of Truth (信頼できる唯一の情報源): グリッドのセルの値ではなく、`BindingList` 内のオブジェクトの状態を真実とすること。
3. Error Boundary (エラー境界): ドラッグ＆ドロップ中のインデックス計算ミスによる `ArgumentOutOfRangeException` を防ぐガードロジックを組み込むこと。

3. プロダクション・コード例

以下に、そのまま実務に投入できるレベルの、型安全で堅牢な実装コードを示す。

データモデルの定義

まず、データの器となるクラスを定義する。実務では `INotifyPropertyChanged` を実装し、プロパティ変更がUIに即座に伝わるようにするのが定石だ。

''' <summary>
''' マスタデータのモデル。
''' 実務では INotifyPropertyChanged を実装してプロパティ変更を通知するのが理想的。
''' </summary>
Public Class MasterItem
    Public Property ID As Integer
    Public Property Name As String
    Public Property SortOrder As Integer ' 並び順を管理するプロパティ
End Class

メインフォームの実装

ここが核心部だ。`BindingList(Of T)` を使い、`MouseDown`, `DragOver`, `DragDrop` イベントを制御する。

Imports System.ComponentModel

Public Class FormMain
    ' データの真実を保持する BindingList
    Private _itemList As BindingList(Of MasterItem)
    ' ドラッグ中のアイテムを保持する一時変数
    Private _draggedItem As MasterItem

    Private Sub FormMain_Load(sender As Object, e As EventArgs) Handles MyBase.Load
        ' 1. サンプルデータの生成
        Dim data = New List(Of MasterItem) From {
            New MasterItem With {.ID = 1, .Name = "アイテム A", .SortOrder = 1},
            New MasterItem With {.ID = 2, .Name = "アイテム B", .SortOrder = 2},
            New MasterItem With {.ID = 3, .Name = "アイテム C", .SortOrder = 3},
            New MasterItem With {.ID = 4, .Name = "アイテム D", .SortOrder = 4}
        }

        ' 2. BindingListにラップしてDataSourceへ。これにより、リストの変更が自動でUIに反映される。
        _itemList = New BindingList(Of MasterItem)(data)
        DataGridView1.DataSource = _itemList

        ' UIの設定
        DataGridView1.AllowDrop = True
        DataGridView1.SelectionMode = DataGridViewSelectionMode.FullRowSelect
        DataGridView1.ReadOnly = True ' ドラッグ操作を優先するため、セル編集は無効化するか制御が必要
    End Sub

    ''' <summary>
    ''' ドラッグ開始：マウスが押された瞬間に、対象のオブジェクトを特定する。
    ''' </summary>
    Private Sub DataGridView1_MouseDown(sender As Object, e As MouseEventArgs) Handles DataGridView1.MouseDown
        Dim hit As DataGridViewHitTestInfo = DataGridView1.HitTest(e.X, e.Y)

        ' 行がヒットした場合のみドラッグを開始
        If hit.RowIndex >= 0 Then
            ' DataGridViewの行から、バインドされている実際のオブジェクトを取り出す
            _draggedItem = DirectCast(DataGridView1.Rows(hit.RowIndex).DataBoundItem, MasterItem)
            
            If _draggedItem IsNot Nothing Then
                ' ドラッグ操作の開始
                DataGridView1.DoDragDrop(_draggedItem, DragDropEffects.Move)
            End If
        End If
    End Sub

    ''' <summary>
    ''' ドラッグ中：マウスカーソルの形状を制御する。
    ''' </summary>
    Private Sub DataGridView1_DragOver(sender As Object, e As DragEventArgs) Handles DataGridView1.DragOver
        ' マウスの位置に基づいて、移動可能であることを示す
        e.Effect = DragDropEffects.Move
    End Sub

    ''' <summary>
    ''' ドロップ：ここがロジックの心臓部。
    ''' DataGridViewではなく、BindingListの順序を入れ替える。
    ''' </summary>
    Private Sub DataGridView1_DragDrop(sender As Object, e As DragEventArgs) Handles DataGridView1.DragDrop
        ' ドロップ位置の行インデックスを取得
        Dim clientPoint As Point = DataGridView1.PointToClient(New Point(e.X, e.Y))
        Dim hit As DataGridViewHitTestInfo = DataGridView1.HitTest(clientPoint.X, clientPoint.Y)

        ' ターゲットとなる行が取得できない場合は終了
        If hit.RowIndex < 0 OrElse _draggedItem Is Nothing Then Exit Sub

        ' 1. 現在のリストからドラッグ中のアイテムを削除
        ' 注意: RemoveではなくRemoveAtを使う方がインデックス管理上安全な場合があるが、
        ' オブジェクト参照によるRemoveはBindingListにおいて非常に強力である。
        _itemList.Remove(_draggedItem)

        ' 2. 新しい位置に挿入
        ' hit.RowIndexは、削除前のインデックスに基づいているため、
        ' 削除後のインデックス調整が必要になるケースがあるが、Insertメソッドは適切に処理する。
        ' ただし、末尾へのドロップを考慮して境界チェックを行う。
        Dim targetIndex As Integer = Math.Min(hit.RowIndex, _itemList.Count)
        _itemList.Insert(targetIndex, _draggedItem)

        ' 3. データの整合性確保（重要！）
        ' 並び替えた結果、SortOrderプロパティなどの順序管理用値を更新する。
        UpdateSortOrders()

        ' 後処理
        _draggedItem = Nothing
    End Sub

    ''' <summary>
    ''' ビジネスロジック：並び替え結果を確定させる。
    ''' </summary>
    Private Sub UpdateSortOrders()
        For i As Integer = 0 To _itemList.Count - 1
            _itemList(i).SortOrder = i + 1
        Next
        ' ここで必要に応じて、DBへの反映（Update SQLの発行など）を検討する。
    End Sub
End Class

4. 実務における「落とし穴」と回避策

このコードを実務に適用する際、以下の3点に注意せよ。これを知っているかどうかが、シニアエンジニアとジュニアエンジニアの分水嶺だ。

① データベース連携のタイミング

ドラッグ＆ドロップのたびに `UPDATE` 文をデータベースに発行してはならない。ユーザーが高速にドラッグ操作を行った場合、データベースへの負荷が急増し、ロック競合を引き起こす。

• 設計指針: 並び替えはメモリ上の `BindingList` で完結させ、「保存」ボタンが押されたタイミング、あるいは一定時間操作が止まったタイミング（デバウンス）で一括してDBへ反映せよ。

② インデックスの不整合

`Remove` と `Insert` を行う際、ドロップした位置が「元の位置より後ろ」か「前」かによって、計算上のインデックスがずれることがある。
上記のコードでは、一旦 `Remove` してから `Insert` するという順序を徹底することで、この複雑な計算を回避し、シンプルでバグの出にくいロジックにしている。

③ UIの反応性

`BindingList` は強力だが、数万件規模のデータを扱う場合、`Insert` や `Remove` のたびに全行の再描画が走り、UIがフリーズする可能性がある。

• 設計指針: 大規模データの場合は、`BindingList` を継承したカスタムクラスを作成し、`RaiseListChangedEvents` プロパティを一時的に `False` にして、操作完了後に一括で `ResetBindings()` を呼び出す設計にせよ。

結論

Windows Formsにおける高度なUI実装とは、単に「動くものを作る」ことではない。「データの整合性を維持したまま、いかにしてユーザーの直感にUIを追従させるか」という設計思想の戦いである。

`DataGridView` の行をいじるな。`BindingList` の中身をいじれ。これが、堅牢な業務システムを構築するための鉄則である。