【入門編】Windows Formsのフォーム終了イベントの制御：FormClosingイベントでの非同期保存処理とキャンセル処理の落とし穴 – Visual Basic (VB / VB.NET)解析バイブル

「保存しますか？」の裏側：Visual Basic (VB / VB.NET)で学ぶ、フォーム終了イベントの奥深い世界

皆さん、こんにちは！ Visual Basic (VB / VB.NET) の世界へようこそ。
マクロの記録から一歩踏み出し、自分で「動くもの」を作ってみたい！ そんな熱い気持ちをお持ちの皆さんのために、今回は Windows Forms アプリケーション設計の、ちょっぴり奥深いけれども、ここを理解すればぐっと応用力が広がる「フォーム終了イベントの制御」について、じっくりお話ししていきたいと思います。

「未保存の変更があります。終了しますか？」という、あのダイアログ。皆さんも一度は目にしたことがあるはずです。この、一見シンプルに見える確認ダイアログの裏側には、実は イベント駆動UI開発 のエッセンスと、オブジェクトのライフサイクル を理解するための大切なヒントが隠されているんです。

今回は、この「フォーム終了イベント」を制することで、アプリケーションの終了処理をより安全に、そしてスマートに制御する方法を、具体的なコード例を交えながら、優しく、そして丁寧に解説していきます。ここをクリアすれば、Visual Basic (VB / VB.NET) の基本はバッチリですよ！

1. アプリケーションが「終わる」って、どういうこと？ – イベント駆動UIの基本

まず、私たちが普段触っている Windows Forms アプリケーションは、「イベント駆動」という仕組みで動いています。これは、ユーザーの操作（ボタンをクリックする、テキストを入力するなど）や、システムからの通知（タイマーが鳴る、ファイルが更新されるなど）といった「イベント」が発生したときに、あらかじめ定義された処理（コード）が実行される、という考え方です。

フォームの終了も、もちろん「イベント」です。ユーザーがウィンドウの「×」ボタンをクリックしたり、メニューから「終了」を選択したりすると、「フォームを閉じようとしている」というイベントが発生します。このイベントを捕捉し、私たちの意図した処理を実行するのが、今回のテーマの核心です。

フォーム終了イベントの主役：`FormClosing` イベント

Windows Forms では、フォームが閉じられる直前に発生するイベントとして、`FormClosing` イベントが用意されています。このイベントは、フォームが完全にメモリから解放される前に、私たちが最後の処理を行うための絶好の機会を与えてくれます。

`FormClosing` イベントの凄さ：保存処理やキャンセル処理を挟み込める！

`FormClosing` イベントの真価は、その 柔軟性 にあります。このイベントハンドラー（イベントが発生したときに実行されるコードのこと）の中で、私たちは主に以下の2つのことができます。

1. 保存処理の実行: ユーザーが未保存の変更があるにも関わらず、うっかりフォームを閉じようとした場合に、自動的にデータを保存する処理を挟み込むことができます。
2. 終了処理のキャンセル: 保存処理が完了しなかったり、あるいはユーザーの意図に反する終了を防ぎたい場合に、フォームが閉じるのを キャンセル することができます。

「ここが落とし穴！」- `FormClosing` イベントでのよくある間違い

さて、ここからが本題です。`FormClosing` イベントをうまく活用するには、その仕組みを正しく理解する必要があります。特に、初心者の方が陥りやすい、そしてベテランでも「あれ？」となりがちな落とし穴がいくつか存在します。

落とし穴1：非同期処理とイベントのタイミング

「未保存の変更があります。終了しますか？」という確認ダイアログを表示し、ユーザーが「はい」と答えたら、バックグラウンドでデータを保存する。そして、保存が完了したらフォームを閉じる…。
この一連の流れを、`FormClosing` イベントの中で実現しようとすると、少し注意が必要です。

もし、保存処理が完了する前にフォームを閉じようとすると、データが失われてしまう可能性があります。特に、データ保存のような時間のかかる処理を、非同期（バックグラウンドで実行される）で行う場合、`FormClosing` イベントの 実行タイミング と 完了タイミング の制御が非常に重要になります。

落とし穴2：キャンセル処理の誤解

`FormClosing` イベントには、`Cancel` という引数があります。この `Cancel` プロパティを `True` に設定すると、フォームの終了をキャンセルできます。しかし、この `Cancel` プロパティの使いどころを間違えると、意図しない動作を引き起こすことがあります。

例えば、保存処理が失敗した場合に `Cancel = True` と設定するのは正しいのですが、保存処理の 完了を待たずに `Cancel = True` としてしまうと、ユーザーは「保存できなかったから終了できない」という状態に陥ってしまい、アプリケーションがフリーズしたかのように見えてしまうかもしれません。

2. 正しいフォーム終了イベント制御パターンの実装

では、これらの落とし穴を回避し、安全かつスマートなフォーム終了処理を実現するための、具体的なコードパターンを見ていきましょう。

サンプルシナリオ：未保存の変更がある場合の確認と自動保存

今回は、以下のようなシナリオで実装してみます。

• フォーム上に、編集可能なテキストボックスがある。
• テキストボックスの内容が変更されたら、それを「未保存」とみなす。
• ユーザーがフォームを閉じようとしたら、
• 未保存の変更があれば、「保存しますか？」と確認ダイアログを表示する。
• ユーザーが「はい」と答えたら、バックグラウンドでデータを保存する。
• 保存が完了したら、フォームを閉じる。
• ユーザーが「いいえ」と答えたら、保存せずにフォームを閉じる。
• 保存処理中にエラーが発生したら、ユーザーに通知し、終了をキャンセルする。
• 変更がない場合は、そのままフォームを閉じる。

実装コード例 (VB.NET)

まずは、フォームのデザインとして、`TextBox` コントロールが一つ配置されていると仮定します。ここでは、その `TextBox` の名前を `txtContent` とします。

.net
‘ フォームのクラス全体を囲む部分です。
Public Class MainForm

‘ ★未保存の変更があるかどうかを管理するフラグ
‘ 初期値は False (変更なし)
Private isContentModified As Boolean = False

‘ ★フォームがロードされたときの処理
Private Sub MainForm_Load(sender As Object, e As EventArgs) Handles MyBase.Load
‘ ここで、保存されていたデータを読み込むなどの初期化処理を行います。
‘ 今回はサンプルとして、初期状態は変更なしとします。
isContentModified = False
‘ 変更がなかったことを示すために、UIも更新しておくと親切です。
UpdateFormTitle()
End Sub

‘ ★テキストボックスの内容が変更されたときに発生するイベント
Private Sub txtContent_TextChanged(sender As Object, e As EventArgs) Handles txtContent.TextChanged
‘ テキストが変更されたら、フラグを True に設定します。
isContentModified = True
‘ フォームのタイトルバーに「※」などをつけて、未保存であることを視覚的に示します。
UpdateFormTitle()
End Sub

‘ ★フォームのタイトルを更新するヘルパーメソッド
Private Sub UpdateFormTitle()
If isContentModified Then
Me.Text = “未保存の変更があります – My Application”
Else
Me.Text = “My Application”
End If
End Sub

‘ ★フォームが閉じられる直前に発生するイベント
Private Async Sub MainForm_FormClosing(sender As Object, e As FormClosingEventArgs) Handles MyBase.FormClosing

‘ ◆◆◆ ここが、フォーム終了イベント制御の核心部分です！ ◆◆◆

‘ 1. 未保存の変更があるかチェック
If isContentModified Then

‘ 2. ユーザーに保存するかどうかを確認
Dim result As DialogResult = MessageBox.Show(“未保存の変更があります。保存しますか？”,
“確認”,
MessageBoxButtons.YesNoCancel,
MessageBoxIcon.Question)

‘ 3. ユーザーの選択肢に応じて処理を分岐
Select Case result
Case DialogResult.Yes
‘ 「はい」が選択された場合：保存処理を実行
Try
‘ ★非同期での保存処理を呼び出します。
‘ await キーワードで、この処理が完了するまでここで待機します。
Await SaveContentAsync()

‘ 保存が成功したら、変更フラグをリセット
isContentModified = False
UpdateFormTitle() ‘ タイトルも元に戻す

‘ 注意：保存処理が成功したので、フォームを閉じてもOKです。
‘ e.Cancel = False はデフォルトの動作なので、明示的に設定する必要はありません。

Catch ex As Exception
‘ ★保存処理中にエラーが発生した場合
MessageBox.Show($”保存中にエラーが発生しました: {ex.Message}”,
“エラー”,
MessageBoxButtons.OK,
MessageBoxIcon.Error)
‘ ★エラーが発生したので、フォームの終了をキャンセルします。
e.Cancel = True
Return ‘ ここで処理を中断し、フォームは閉じられません。
End Try

Case DialogResult.No
‘ 「いいえ」が選択された場合：保存せずにフォームを閉じる
‘ e.Cancel = False はデフォルトの動作なので、明示的に設定する必要はありません。
‘ 変更フラグはリセットしません。次回起動時に再度確認させたい場合など。

Case DialogResult.Cancel
‘ 「キャンセル」が選択された場合：フォームの終了をキャンセルする
e.Cancel = True
Return ‘ ここで処理を中断し、フォームは閉じられません。
End Select
End If

‘ ★ここまで到達した場合、または isContentModified が False だった場合は、
‘ フォームは閉じられます (e.Cancel は False のまま)。
‘ もし、上記で e.Cancel = True が設定された場合は、この部分は実行されません。

End Sub

‘ ★非同期での保存処理メソッド (例)
‘ Async キーワードで非同期メソッドであることを示します。
‘ Task を返すことで、完了を待つことができます。
Private Async Function SaveContentAsync() As Task
‘ ここに、実際のデータ保存処理を記述します。
‘ 例えば、ファイルへの書き込み、データベースへの保存など。
‘ 処理に時間がかかることをシミュレートするために、少し待機させます。
Await Task.Delay(2000) ‘ 2秒間待機 (非同期処理)

‘ 保存処理が成功したと仮定します。
‘ もしエラーが発生する場合は、ここで Exception をスローします。
‘ 例:
‘ If someConditionFails Then
‘ Throw New Exception(“データが不正です。”)
‘ End If

‘ 保存成功！
Console.WriteLine(“データが非同期で保存されました。”)
End Function

‘ ★フォームが実際に閉じられた後の処理 (オプション)
Private Sub MainForm_FormClosed(sender As Object, e As FormClosedEventArgs) Handles MyBase.FormClosed
‘ ここでは、フォームが完全に閉じられた後のクリーンアップ処理などを行います。
‘ FormClosing イベントとは異なり、ここでは終了をキャンセルすることはできません。
Console.WriteLine(“フォームが閉じられました。”)
End Sub

‘ ★サンプルとして、フォームのロード時に何か表示する処理
Private Sub MainForm_Load_1(sender As Object, e As EventArgs) Handles MyBase.Load
‘ フォームに表示するテキストボックスに初期値を設定
txtContent.Text = “ここに初期テキストが入ります。”
End Sub

End Class

コード解説：一歩ずつ理解しよう！

• `isContentModified As Boolean`:
• これは、フォームの内容が変更されたかどうかを記録するための「フラグ」です。
• `True` なら変更あり、`False` なら変更なし、という状態を保持します。
• フォームのライフサイクル（作成・表示・終了）を通じて、このフラグの状態を管理することが、安全な終了処理の第一歩です。

• `MainForm_Load`:
• フォームが最初に表示されるときに実行されます。
• ここでは、`isContentModified` を `False` に初期化し、タイトルバーも「変更なし」の状態にしています。

• `txtContent_TextChanged`:
• ユーザーが `txtContent` テキストボックスに文字を入力したり、削除したりするたびに発生します。
• このイベントが発生したら、迷わず `isContentModified` を `True` に設定しましょう。
• `UpdateFormTitle()` を呼び出して、ユーザーに「未保存だよ」と視覚的に伝え、親切なUIを提供します。

• `UpdateFormTitle()`:
• フォームのタイトルバーのテキストを、`isContentModified` の状態に応じて更新する簡単なヘルパーメソッドです。
• 「※」マークなどを付けると、さらに分かりやすくなりますね。

• `Async Sub MainForm_FormClosing(…) Handles MyBase.FormClosing`:
• ここが主役です！
• `Handles MyBase.FormClosing` で、このメソッドが `FormClosing` イベントを処理することを明示しています。
• `Async Sub` となっているのがポイントです！ これにより、メソッド内で `Await` キーワードを使って非同期処理（`SaveContentAsync` など）を待つことができます。
• `If isContentModified Then`: まず、変更がある場合のみ、確認処理に進みます。変更がなければ、そのままフォームは閉じられます。
• `MessageBox.Show(…)`:
• ユーザーに「保存しますか？」と尋ねるダイアログを表示します。
• `MessageBoxButtons.YesNoCancel` で「はい」「いいえ」「キャンセル」の3つのボタンを用意しています。
• `result` 変数に、ユーザーがどのボタンを押したかの結果が格納されます。
• `Select Case result`:
• `Case DialogResult.Yes`:
• `Try…Catch` ブロック: 保存処理中にエラーが発生する可能性を考慮し、`Try…Catch` で囲みます。
• `Await SaveContentAsync()`: ここで、非同期の保存処理を呼び出し、その完了を待ちます。`Await` があるおかげで、保存処理が終わるまで、この `FormClosing` イベントハンドラーはここで一時停止し、UIがフリーズすることはありません。
• `isContentModified = False`: 保存が成功したら、フラグをリセットします。
• `Catch ex As Exception`: もし `SaveContentAsync()` の中で例外（エラー）が発生したら、ここに処理が移ります。
• エラーメッセージをユーザーに表示します。
• `e.Cancel = True`: ここが重要！ エラーが発生したため、フォームの終了をキャンセルします。これにより、アプリケーションは閉じられず、ユーザーはエラーに対処する機会を得られます。
• `Return`: `FormClosing` イベントハンドラーをここで終了させます。`e.Cancel = True` が有効になります。
• `Case DialogResult.No`:
• 保存せずに閉じたい、というユーザーの意思を尊重します。
• `e.Cancel` はデフォルトで `False` なので、何も設定する必要はありません。フォームは閉じられます。
• `Case DialogResult.Cancel`:
• ユーザーが「キャンセル」ボタンを押した場合です。
• `e.Cancel = True`: フォームの終了をキャンセルします。
• `Return`: `FormClosing` イベントハンドラーをここで終了させます。

• `Async Function SaveContentAsync() As Task`:
• これは、実際のデータ保存処理を行うメソッドです。
• `Async Function` と `Task` を返すことで、非同期処理であることを示しています。
• `Await Task.Delay(2000)`: これは、保存処理に時間がかかることをシミュレーションするためのコードです。実際のアプリケーションでは、ここにファイルIOやネットワーク通信などの処理が入ります。
• `Throw New Exception(…)`: もし保存処理中にエラーが発生したら、ここで `Exception` をスローします。これにより、呼び出し元の `Catch` ブロックでエラーを捕捉できます。

• `MainForm_FormClosed`:
• フォームが 完全に 閉じられた後に実行されるイベントです。
• `FormClosing` とは異なり、ここでは `e.Cancel = True` を設定しても、フォームの終了をキャンセルすることはできません。あくまで、後処理を行う場所です。

概念図で理解！`FormClosing` イベントの流れ

graph TD
A[ユーザーがフォームを閉じようとする] –> B{未保存の変更があるか？};
B — No –> C[フォームを閉じる];
B — Yes –> D[「保存しますか？」ダイアログ表示];
D –> E{ユーザーの選択};
E — Yes –> F[保存処理開始 (Async)];
F –> G{保存処理は成功したか？};
G — Yes –> H[変更フラグをリセット];
H –> C;
G — No –> I[エラーメッセージ表示];
I –> J[フォームの終了をキャンセル];
E — No –> C;
E — Cancel –> J;

3. パフォーマンスの観点から – 非同期処理の重要性

今回の例で `Async` と `Await` を使って非同期処理を導入したのには、明確な理由があります。それは パフォーマンス です。

もし、保存処理のような時間のかかる処理を、同期的に（つまり、処理が終わるまで待ってから次に進む形式で） `FormClosing` イベント内で実行してしまうと、どうなるでしょうか？

• ユーザーが「×」ボタンを押した瞬間、保存処理が始まります。
• 保存処理が終わるまで、アプリケーションは 完全にフリーズ してしまいます。
• ユーザーは何も操作できなくなり、アプリケーションが応答していないように見えてしまいます。

`Async` と `Await` を使うことで、保存処理をバックグラウンドで実行させ、その完了を待っている間も、UI（ユーザーインターフェース）は応答可能状態を保つことができます。これは、ユーザーエクスペリエンス（UX）を大きく向上させるための、現代的なアプリケーション開発では不可欠なテクニックです。

4. まとめ：これであなたもフォーム終了イベントマスター！

さて、今回は Visual Basic (VB.NET) における `FormClosing` イベントの制御について、未保存の変更がある場合の確認処理と、非同期での保存処理、そしてキャンセル処理の正しいパターンを解説しました。

• `FormClosing` イベントは、フォームが閉じる直前の最後のチャンス！
• `isContentModified` のようなフラグで、変更状態を管理しよう。
• ユーザーの操作（`MessageBox` の結果）に応じて、処理を分岐させよう。
• 時間のかかる処理は `Async`/`Await` で非同期に行い、UIの応答性を保とう。
• エラー発生時や、ユーザーがキャンセルした場合は、`e.Cancel = True` で終了をキャンセルしよう。

これらのポイントをしっかり押さえれば、皆さんのアプリケーションは、より安全に、そしてユーザーフレンドリーに動作するようになります。
「ここをクリアすれば、Visual Basic (VB / VB.NET) の基本はバッチリですよ」という言葉通り、この `FormClosing` イベントの制御は、Windows Forms アプリケーション開発における「基本のキ」と言えるでしょう。

ぜひ、今回学んだコードを参考に、ご自身のアプリケーションに実装してみてください。
もし、分からない点や、さらに深掘りしたい点があれば、いつでも気軽に質問してくださいね！

それでは、また次の記事でお会いしましょう！