WinForms の入力チェックを ErrorProvider でスマートに — Validating と e.Cancel の落とし穴

みなさんこんにちは！ヒロポンです！

業務フォームの入力チェック、MessageBox の連打になってませんか？？

必須項目が空 → 「名前を入力してください」でポンッ。日付がおかしい → 「日付の形式が不正です」でまたポンッ。

OK を押しては、次のエラーで止められる。使う側からすると、地味にストレスなんですよね。

これ、ErrorProvider と Validating イベントを使うと、入力欄の横に赤いアイコンとツールチップでスマートに出せます。 MessageBox で作業を止めなくて済む。

今回は「WinForms の入力チェックを ErrorProvider でスマートにする方法」を、コピペで動くコードでまとめました。

あと Validating の e.Cancel でフォームが閉じられなくなる詰み方。ここが一番の落とし穴なので、しっかり開示します。

💡 メールや電話番号の形式チェックそのものは C# 正規表現の業務系入力検証5パターン にまとめてます。今回はその検証結果を画面にどう出すか、ErrorProvider 側の話です。

結論: ErrorProvider + Validating で入力欄の横に赤アイコンを出す

先に答えです。やることは2つ。

1. フォームに ErrorProvider を1つ置く
2. 各入力欄の Validating イベントで、NG なら SetError、OK なら空を SetError

// フォームに ErrorProvider を1つ用意 (デザイナで置いてもOK)
private ErrorProvider errorProvider1 = new ErrorProvider();

// 名前欄の Validating イベント
private void txtName_Validating(object sender, CancelEventArgs e)
{
    if (string.IsNullOrWhiteSpace(txtName.Text))
        errorProvider1.SetError(txtName, "名前は必須です");   // 横に赤アイコン + ツールチップ
    else
        errorProvider1.SetError(txtName, "");                 // 空を渡すとアイコンが消える
}

これだけで、名前欄が空のままフォーカスが外れると、欄の右に赤いアイコンが出ます。マウスを乗せると「名前は必須です」のツールチップ。いい感じにスマート。

ここまでで「あとは各欄に付けるだけ」と分かった人は、ページを閉じてもらってもかまいません！ 以下は一括検証のやり方と、e.Cancel の詰み方の話です。

そもそも: ErrorProvider と Validating の役割

ErrorProvider は、コントロールの横にエラーアイコンとツールチップを表示するコンポーネント です。フォームに1個置いておけば、どのコントロールに対しても SetError でエラーを出し分けられます。

Validating は、コントロールからフォーカスが外れる直前に発火するイベント です。「入力を終えて次の欄に移ろうとした瞬間」に呼ばれる。だから入力チェックの定位置になります。

この2つを組み合わせると、「入力し終わった欄から順にチェックして、ダメなら横に赤マーク」という自然な検証ができます。

MessageBox みたいに作業を止めない。ここがポイントです。

最短実装（コピペで動く）

ステップ1: Validating で SetError する

各入力欄の Validating に検証を書きます。日付欄ならこんな感じ。

private void txtDate_Validating(object sender, CancelEventArgs e)
{
    if (!DateTime.TryParse(txtDate.Text, out _))
        errorProvider1.SetError(txtDate, "日付の形式が正しくありません");
    else
        errorProvider1.SetError(txtDate, "");
}

DateTime.TryParse で弾いて、NG なら SetError、OK なら空を渡してクリア。

この「OK の時に空を SetError してクリアする」を忘れると、一度出た赤マークが、直しても消えません。そこだけ注意です。

ステップ2: 保存前に ValidateChildren で一括検証

項目ごとの検証は上でできます。ただ、保存ボタンを押した時に「全部まとめてチェック」したいですよね。そこで ValidateChildren です。

private void btnSave_Click(object sender, EventArgs e)
{
    // フォーム上の全コントロールの Validating をまとめて実行
    if (this.ValidateChildren())
        SaveData();                              // 全部OKなら保存
    else
        MessageBox.Show("入力エラーがあります。赤いマークの欄を確認してください。");
}

this.ValidateChildren() を呼ぶと、フォーム上の全コントロールの Validating が走ります。1つでもエラー（e.Cancel = true）があれば false が返る。

保存直前の最終チェックに、ちょうどいいです。

ハマりポイント: 知らないと詰む3つ

ここが本番です。特に①は、私も一度これで冷や汗かきました。

① e.Cancel = true でフォーカスが抜けられなくなる「詰み」

Validating の e.Cancel = true は、検証に失敗したコントロールからフォーカスを移動させない 効果があります。一見「入力を強制できて便利」に見えるんですよね。

ん？ 便利じゃん、と思いきや、これが罠。

private void txtName_Validating(object sender, CancelEventArgs e)
{
    if (string.IsNullOrWhiteSpace(txtName.Text))
    {
        errorProvider1.SetError(txtName, "名前は必須です");
        e.Cancel = true;   // ← これを入れると txtName から出られなくなる
    }
}

これ、名前欄が空のままだと 他のどの欄にも移れず、フォームの閉じるボタンすら効かなくなります。 ユーザーは「名前を入れるまでフォームを閉じられない」状態に閉じ込められる。

私も昔これをやって、テスト中に私のフォームが閉じられなくなって、タスクマネージャーから落とすハメになりました。自作のフォームに、作った本人が閉じ込められる。まさに詰み。笑えないですよね？？

閉じるボタンやキャンセルボタンまで検証に巻き込まれるのが原因です。

対策は2つ。閉じる・キャンセル系のボタンは CausesValidation = false にする。もう1つは、そもそも e.Cancel を使わず SetError だけで表示して、保存時に ValidateChildren で最終判定する設計にする。

後者のほうが素直で、私は基本こっちにしてます。

② CausesValidation を切り忘れて、キャンセルできない

①の対策の続き。CausesValidation は、そのコントロールにフォーカスが移る時に、直前のコントロールの Validating を発火させるか を決めるプロパティです。既定は true。

// 閉じる・キャンセルボタンは検証をトリガーさせない
btnCancel.CausesValidation = false;
btnClose.CausesValidation  = false;

これを切っておかないと、入力途中で「やっぱりキャンセル」を押したくても、直前の欄の Validating が走って e.Cancel = true に引っかかります。キャンセルボタンまで到達できない。

キャンセル・閉じる系は CausesValidation = false。これを覚えておくと安全です。

③ Validating はフォーカスが動かないと発火しない

Validating は「フォーカスが外れる時」に発火するイベントです。つまり、入力欄に一度もフォーカスが当たらなかったり、当たったまま保存ボタンを押したりすると発火しない ことがあります。

だから「項目ごとの Validating に任せきり」だと、ユーザーが触ってない欄はノーチェックで通る。

ここを埋めるのが、さっきの ValidateChildren です。保存時に ValidateChildren を1回通す。これで「触ってない必須欄」も、いい感じに漏れなく拾えます。