WinFormsのFormClosingイベントハンドラをasyncにすると画面が閉じません

Question

asyncなFormClosingイベントハンドラで、以下の実装をしたところFormClosedイベントが起きず、フォームが閉じません。
ブレークポイントを置いて実行したところ、e.Cancel = false; は実行されるのですが、なぜ画面が閉じないのでしょうか？

###該当のソースコード

        private async void Form1_FormClosing(object sender, FormClosingEventArgs e)
        {
            e.Cancel = true;
            await Task.Delay(1000); //重たい処理
            e.Cancel = false;
         }

###試したこと
以下のコードの場合、閉じたり閉じなかったりします。
コントロールボックスの×ボタンを連打するとそのうち閉じるのですが、なぜこんな動作をするんでしょうか？
(Taskが即座に終わるかどうかが関係している？)

        private async void Form1_FormClosing(object sender, FormClosingEventArgs e)
        {
            e.Cancel = true;
            await Task.Run(() =>
            {
                return;
            });
            e.Cancel = false;
        }

###補足情報(言語/FW/ツール等のバージョンなど)
.Net Framework 4.5
VS2012

Answer 1

await で一度イベントハンドラが終了します。その時 e.Cancel は true です。
ですのでフォームは閉じません。

しかし e.Cancel が評価される前にタスクが終了して e.Cancel が書き換えられるとフォームは閉じます。

追記

わかりにくかったかもしれないので順を追って説明します。

これは System.Windows.Forms.Form のソースです。
Form.cs

OnFormClosing(e);
if (e.Cancel)
{
    dialogResult = DialogResult.None;
}
else
{
    // we have called closing here, and it wasn't cancelled, so we're expecting a close
    // call again soon.
    CalledClosing = true;
}

上記の OnFormClosing(e); で FormClosing イベントハンドラを(あれば)呼びます。
ユーザーはハンドラの中で e.Cancel を設定します。
イベントハンドラが次のようになっている場合

private async void Form1_FormClosing(object sender, FormClosingEventArgs e)
{
    e.Cancel = true;
    await Task.Run(() =>
    {
        return;
    });
    e.Cancel = false;
}

await によって一度ハンドラが終了するので、次のようなハンドラを指定したのと同じことになります。

private async void Form1_FormClosing(object sender, FormClosingEventArgs e)
{
    e.Cancel = true;
}

そして同時に次の非同期処理が登録されます。
(実際に実行されるのは同時とは限りません)

Task.Run(() =>
{
    return;
});
e.Cancel = false;

この非同期処理は return のみのタスクを実行し、それが終了すると e.Cancel = false というタスクを実行しますので、整理すると次の内容とほぼ同じです。

Task.Run(() =>
{
    e.Cancel = false;
});

さてこの非同期処理がいつ行われるかですが、それは実行してみるまでわかりません。
この処理によって e.Cancel が書き換えられるわけですが、それが Form.cs 中の

if (e.Cancel)

この部分より前に行われると、e.Cancel は false となって else ブロックが実行されます。
また、後に行われたならば真のブロックが実行されます。

重たい処理の場合はおそらく間に合わないので e.Cancel は true となります。
二番目の例の場合は間に合うか間に合わないかは状況次第です。

以上が処理の流れとなります。

Comments

[Zuishin]

await はその名前から「待つ」と理解しがちですが、「非同期タスクが終わった後の処理を予約して終了する」と考えた方が理解しやすいです。

[ry18847]

回答ありがとうございます。
FormClosingイベントハンドラの処理がすべて完了してからFormClosedが起きると思っていましたが、違うのですね。

ということは、FormClosingイベントで非同期に重い処理をしたい場合は、重たい処理以降で必要に応じてthis.Close();し直す(この場合は重たい処理が再度走らないようにフラグ管理等する)必要があるという認識でいいでしょうか？
（そもそも重い処理を終わらせてからthis.Close(); したほうがいいのでしょうけど・・・）

[Zuishin]

フォームが閉じるのに必要な処理なら非同期にせず同期処理で待たせましょう。
その間のループ中に `Application.DoEvents()` を繰り返し呼んでメッセージを処理するといいと思います。

[ry18847]

ご丁寧な解説をいただき、ありがとうございます。
同期で待たせてApplication.DoEvents()で処理することを検討してみたいと思います。

最後に1点、今回例にした重い処理の正体は画面を閉じるとき以外にも実行する非同期通信処理メソッドでして、Closingイベント中ではループがありません。
この場合はどのようにDoEvents()を繰り返し実行させればよいでしょうか？
（Application.DoEvents();を無限ループ処理するTaskを作ってWhenAny()を使う？）

[Zuishin]

その方法が簡単だと思います。
どの程度重いのかにもよりますが、ShowDialog() でプログレスダイアログを出してその Shown イベントで非同期処理を行い、処理が終わってダイアログが閉じられるのを待つという手もあります。

[ry18847]

ご回答ありがとうございました！
イベントハンドラおよび非同期処理については引き続き勉強していきたいと思います。

[Zuishin]

書くのを忘れていました。無限ループを使う場合には非同期処理が始まらない場合があるので、その時には非同期処理を別スレッドに追い出す必要があります。TaskScheduler を調べてください。