[Tips] Validatingイベントを使用する その3 ~ フォーカス移動時のValidatingイベントを抑制する ~

前回までの記事はこちら


Validatingイベントで入力チェックを実施し、 e.Cancel = true にすることで、他のコントロールへフォーカスが移動できなくなるのはこれまでに説明した通りです。

今回は、Validatingイベント後のフォーカス移動先が、[キャンセル]や[閉じる]ボタンの場合を考えてみます。

前回までに作成したプログラムで実験をしてみましょう。

1.データ1のテキストボックスに「hiros.net」と入力します。
2.[閉じる]ボタンをクリックします。

現在までのコードだと、データ1に不正な文字が入力されている場合は下図のようになり、当然画面を閉じることはできません。
画面を閉じたければ、エラーを修正するしか方法がありません。

実行例

上記の問題を解決するには、Validatingイベントを発生させたくないコントロールの CauseValidationプロパティに falseをセットする必要があります。
このように設定を行うと、データ1のテキストボックスに不正があったとしても、フォーカスが[閉じる]ボタンへ移動しても、Validatingイベントは発生しなくなり、エラーを修正しなくても画面を閉じることができるようになります。

次にフォーム右上の[X]ボタンはどうでしょうか。
これも、データ1のテキストボックスにエラーがある場合は、画面を閉じることができません。
この問題は、Validatingイベント内で ActiveControlをチェックすることで回避することが可能です。
通常、Validatingイベントが発生した場合は、ActiveControlプロパティはすでに次のコントロールになっています。
今回の例では、txtData1のValidatingイベントが発生すると、ActiveControlの値はtxtData2となります。
しかし、[Esc]やフォーム右上の[X]ボタンがクリックされた場合には、ActiveControlプロパティの値は txtData1のままとなっているのです。
これを図にすると以下のようになります。

フォーカス移動時のイメージ

以上のことを利用すると、txtData1のValidatingイベントの中で e.Cancel = true にする条件は

1.不正な文字が含まれている
2.ActiveControlがtxtData1以外のとき
の2つを満たしているときとなります。

コード例は以下の通りです。

VBの例

Private Sub txtData1_Validating(sender As Object, e As System.ComponentModel.CancelEventArgs) Handles txtData1.Validating
    ' 不正な文字「.」が含まれている かつ ActiveControlがtxtData1ではない
    If txtData1.Text.IndexOf(".") > -1 AndAlso ActiveControl IsNot txtData1 Then
        MessageBox.Show("不正な文字「.」が含まれています")

        ' 後続のイベントをキャンセル
        e.Cancel = True

        'txtData1 にエラーアイコンとメッセージの表示をセット
        errorProvider1.SetError(txtData1, "不正な文字が入力されています。")
    End If
End Sub

C#の例

private void textBox1_Validating(object sender, CancelEventArgs e)
{
    // 不正な文字「.」が含まれている かつ ActiveControlがtxtData1ではない
    if (txtData1.Text.IndexOf('.') > -1  && ActiveControl != txtData1)
    {                
        MessageBox.Show("不正な文字「.」が含まれています");

        // 後続のイベントをキャンセル
        e.Cancel = true;

        // txtData1 にエラーアイコンとメッセージの表示をセット
        errorProvider1.SetError(txtData1, "不正な文字が入力されています。");
    }
}

以上で、フォームの[X]ボタンクリック時に Validatingイベントを発生することなくフォームを閉じることができるようになります。

[Tips] Validatingイベントを使用する その2 ~ ErrorProviderコントロールとの組み合わせ ~

[Tips] Validatingイベントを使用する その1 では基本的な使い方について説明しました。
今回は、Validatingイベントと ErrorProviderコントロールを組み合わせて、不正な文字が入力さている場合にエラーアイコンを表示する方法について説明します。

デザインは以下のようにします。
前回のデザインに ErrroProviderコントロールを追加しただけです。

画面デザイン

不正な文字の入力チェックは、前回同様 Validatingイベントで行います。
不正な文字が入力されていた場合は、errorProviderコントロールの SetErrorメソッドを呼び出すコードを追加します。
そして、入力チェックにおいて不正な文字が見つからなかった場合(要するに Validatingイベントで e.Cancel = trueにしなかった場合)は、エラーが発生していないことになるので ErrorProviderコントロールの SetErrorメソッドでエラー状態をクリアしてあげます。

以下にコード例を示します。

VBの例

Private Sub txtData1_Validating(sender As Object, e As System.ComponentModel.CancelEventArgs) Handles txtData1.Validating
    ' 不正な文字「.」が含まれているか?
    If txtData1.Text.IndexOf(".") > -1 Then
        MessageBox.Show("不正な文字「.」が含まれています")

        ' 後続のイベントをキャンセル
        e.Cancel = True

        'txtData1 にエラーアイコンとメッセージの表示をセット
        errorProvider1.SetError(txtData1, "不正な文字が入力されています。")
    End If
End Sub

Private Sub txtData1_Validated(sender As Object, e As EventArgs) Handles txtData1.Validated
    'txtData1のエラーを解除
    errorProvider1.SetError(txtData1, "")
End Sub

C#の例

private void textBox1_Validating(object sender, CancelEventArgs e)
{
    // 不正な文字「.」が含まれているか?
    if (txtData1.Text.IndexOf('.') > -1 && this.ActiveControl != txtData1)
    {                
        MessageBox.Show("不正な文字「.」が含まれています");

        // 後続のイベントをキャンセル
        e.Cancel = true;

        // txtData1 にエラーアイコンとメッセージの表示をセット
        errorProvider1.SetError(txtData1, "不正な文字が入力されています。");
    }
}

private void txtData1_Validated(object sender, EventArgs e)
{
    // txtData1のエラーを解除
    errorProvider1.SetError(txtData1, "");
}

実行例は以下の通りです。
実行例

[Tips] Validatingイベントを使用する その1 ~ 基本的な使い方 ~

Windows Formアプリケーションで入力チェックを行うには Validatingイベントを使用します。

例として、以下のような画面で考えてみます。

画面デザイン

データ1(テキストボックス)に不正な値が含まれている場合に、ほかのコントロールにフォーカスを移動できないようにするには

1.データ1のValidatingイベント内で入力チェックをする
2.不正な値が含まれている場合は、Validatingイベントの引数 e.Cancelに trueをセット

を実施します。
CauseVaidatingプロパティに false がセットされている場合は Validatingイベントは発生しないので注意が必要です。

データ1のTextBoxで「.」を不正文字として扱う時のコード例は以下の通りです。

VBの例

Private Sub txtData1_Validating(sender As Object, e As System.ComponentModel.CancelEventArgs) Handles txtData1.Validating
    ' 不正な文字「.」が含まれているか?
    If txtData1.Text.IndexOf(".") > -1 Then
        MessageBox.Show("不正な文字「.」が含まれています")

        ' 後続のイベントをキャンセル
        e.Cancel = True
    End If
End Sub

'[キャンセル]ボタンのイベント
Private Sub btnCancel_Click(sender As Object, e As EventArgs) Handles btnCancel.Click
    Me.Close()
End Sub

C#の例

private void textBox1_Validating(object sender, CancelEventArgs e)
{
    // 不正な文字「.」が含まれているか?
    if (txtData1.Text.IndexOf('.') > -1 && this.ActiveControl != txtData1)
    {                
        MessageBox.Show("不正な文字「.」が含まれています");

        // 後続のイベントをキャンセル
        e.Cancel = true;
    }
}

// [キャンセル]ボタンのイベント
private void btnCancel_Click(object sender, EventArgs e)
{
    this.Close();
}

TextBoxコントロールのインベントは、ほかのコントロールへフォーカスが移動するとき以下の順でイベントが発生します。
コード例の中のコメントでも書いていますが、e.Cancel = true は後続のイベントをキャンセルします。

Leave → Validating → Validated

よって Validatedイベントは発生しませ。これにより、ほかのコントロールへフォーカスは移動しなくなります。