[C#] MaskedTextBoxのバリデーション方法

2024-09-15

MaskedTextBoxは、ユーザー入力を特定のフォーマットに制限するためのコントロールです。

バリデーションを行うには、まずMaskプロパティを設定して入力フォーマットを指定します。

例えば、電話番号や郵便番号の形式を指定できます。

入力が完了したら、MaskedTextBoxのMaskCompletedプロパティを使用して、ユーザーがすべての必須フィールドを正しく入力したかを確認します。

また、Validatingイベントを利用して、カスタムバリデーションロジックを追加することも可能です。

これにより、入力がフォーマットに合致しているかをチェックし、不正な入力があればエラーメッセージを表示することができます。

この記事でわかること

MaskedTextBoxの基本的な使い方
バリデーションの重要性と方法
正規表現を用いた入力制限
カスタムメソッドによるバリデーション
ユーザーへのフィードバック方法

目次から探す

バリデーションの基本

バリデーションの必要性

バリデーションは、ユーザーが入力したデータが正しい形式であるかを確認するプロセスです。

特に、MaskedTextBoxを使用する場合、特定の形式(電話番号や郵便番号など)を強制することができます。

これにより、データの整合性を保ち、後続の処理でエラーを防ぐことができます。

バリデーションを行うことで、ユーザーエクスペリエンスを向上させることも可能です。

MaskCompletedプロパティの利用

MaskedTextBoxには、MaskCompletedプロパティがあります。

このプロパティは、ユーザーがマスクされた入力をすべて完了したかどうかを示します。

例えば、電話番号の入力が完了したかを確認する際に利用できます。

以下は、MaskCompletedプロパティを使用したサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
    }
    private void maskedTextBox1_Leave(object sender, EventArgs e)
    {
        // 入力が完了しているか確認
        if (maskedTextBox1.MaskCompleted)
        {
            MessageBox.Show("入力が完了しました。");
        }
        else
        {
            MessageBox.Show("入力が不完全です。");
        }
    }
}

このコードでは、MaskedTextBoxからフォーカスが外れたときに、入力が完了しているかどうかをチェックし、メッセージボックスで結果を表示します。

MaskFullプロパティの利用

MaskFullプロパティは、MaskedTextBoxに入力されたデータがマスク全体を満たしているかどうかを示します。

このプロパティを使用することで、ユーザーが必要なすべての情報を入力したかを確認できます。

以下は、MaskFullプロパティを使用したサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
    }
    private void maskedTextBox1_Leave(object sender, EventArgs e)
    {
        // 入力がマスク全体を満たしているか確認
        if (maskedTextBox1.MaskFull)
        {
            MessageBox.Show("全ての情報が入力されました。");
        }
        else
        {
            MessageBox.Show("情報が不足しています。");
        }
    }
}

このコードでは、MaskedTextBoxからフォーカスが外れたときに、全ての情報が入力されているかを確認し、結果をメッセージボックスで表示します。

これにより、ユーザーが必要な情報を漏れなく入力できるように促すことができます。

イベントを利用したバリデーション

Validatingイベントの活用

Validatingイベントは、ユーザーがMaskedTextBoxからフォーカスを外そうとしたときに発生します。

このイベントを利用することで、入力内容のバリデーションを行い、必要に応じてフォーカスを戻すことができます。

以下は、Validatingイベントを使用したサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
    }
    private void maskedTextBox1_Validating(object sender, CancelEventArgs e)
    {
        // 入力が不完全な場合、フォーカスを戻す
        if (!maskedTextBox1.MaskCompleted)
        {
            MessageBox.Show("入力が不完全です。再度入力してください。");
            e.Cancel = true; // フォーカスを戻す
        }
    }
}

このコードでは、MaskedTextBoxの入力が不完全な場合、メッセージボックスを表示し、フォーカスを戻すようにしています。

これにより、ユーザーは再度入力を行うことができます。

Validatedイベントの活用

Validatedイベントは、Validatingイベントが成功した後に発生します。

このイベントを利用して、入力が正しい場合の処理を行うことができます。

以下は、Validatedイベントを使用したサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
    }
    private void maskedTextBox1_Validated(object sender, EventArgs e)
    {
        // 入力が正しい場合の処理
        MessageBox.Show("入力が正しいです。");
    }
}

このコードでは、MaskedTextBoxの入力が正しい場合にメッセージボックスを表示します。

これにより、ユーザーに対して入力が成功したことを通知できます。

エラーメッセージの表示方法

エラーメッセージを表示する方法はいくつかありますが、一般的にはMessageBoxを使用するのが簡単です。

また、Labelコントロールを使用して、フォーム内にエラーメッセージを表示することもできます。

以下は、Labelを使用したエラーメッセージの表示方法のサンプルコードです。

partial class MyForm : Form
{
    private Label errorLabel; // エラーメッセージ用のLabel
    public MyForm()
    {
        InitializeComponent();
        errorLabel = new Label();
        errorLabel.ForeColor = Color.Red; // エラーメッセージを赤色に設定
        Controls.Add(errorLabel); // フォームにLabelを追加
    }
    private void maskedTextBox1_Validating(object sender, CancelEventArgs e)
    {
        // 入力が不完全な場合、エラーメッセージを表示
        if (!maskedTextBox1.MaskCompleted)
        {
            errorLabel.Text = "入力が不完全です。再度入力してください。";
            e.Cancel = true; // フォーカスを戻す
        }
        else
        {
            errorLabel.Text = ""; // エラーメッセージをクリア
        }
    }
}

このコードでは、MaskedTextBoxの入力が不完全な場合にエラーメッセージをLabelに表示し、入力が正しい場合にはエラーメッセージをクリアします。

これにより、ユーザーはどのようなエラーが発生しているのかを視覚的に確認できます。

カスタムバリデーションの実装

正規表現を用いたバリデーション

正規表現を使用することで、特定のパターンに基づいた入力のバリデーションを行うことができます。

MaskedTextBoxの入力内容が特定の形式に従っているかを確認するために、Regexクラスを利用します。

以下は、正規表現を用いたバリデーションのサンプルコードです。

using System.Text.RegularExpressions; // 正規表現を使用するための名前空間
partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
    }
    private void maskedTextBox1_Validating(object sender, CancelEventArgs e)
    {
        // 正規表現を用いて電話番号の形式を確認
        string pattern = @"^\d{3}-\d{4}-\d{4}$"; // 例: 123-4567-8901
        if (!Regex.IsMatch(maskedTextBox1.Text, pattern))
        {
            MessageBox.Show("電話番号の形式が正しくありません。");
            e.Cancel = true; // フォーカスを戻す
        }
    }
}

このコードでは、電話番号の形式が 123-4567-8901 のようになっているかを正規表現で確認し、形式が正しくない場合にはエラーメッセージを表示します。

カスタムメソッドによるバリデーション

カスタムメソッドを作成することで、より複雑なバリデーションロジックを実装することができます。

以下は、カスタムメソッドを使用したバリデーションのサンプルコードです。

partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
    }
    private void maskedTextBox1_Validating(object sender, CancelEventArgs e)
    {
        // カスタムメソッドを呼び出してバリデーションを行う
        if (!IsValidInput(maskedTextBox1.Text))
        {
            MessageBox.Show("入力が無効です。再度確認してください。");
            e.Cancel = true; // フォーカスを戻す
        }
    }
    private bool IsValidInput(string input)
    {
        // ここにバリデーションロジックを実装
        return input.Length == 10; // 例: 入力が10文字であることを確認
    }
}

このコードでは、IsValidInputメソッドを作成し、入力が10文字であるかを確認しています。

条件に合わない場合にはエラーメッセージを表示し、フォーカスを戻します。

バリデーション結果のフィードバック

バリデーションの結果をユーザーにフィードバックする方法はいくつかあります。

メッセージボックスやLabelを使用することが一般的ですが、ToolTipを使用して入力フィールドの近くにメッセージを表示することもできます。

以下は、ToolTipを使用したバリデーション結果のフィードバックのサンプルコードです。

using System.Windows.Forms; // ToolTipを使用するための名前空間
partial class MyForm : Form
{
    private ToolTip toolTip; // ToolTipのインスタンス
    public MyForm()
    {
        InitializeComponent();
        toolTip = new ToolTip(); // ToolTipの初期化
    }
    private void maskedTextBox1_Validating(object sender, CancelEventArgs e)
    {
        // バリデーションを行い、結果をToolTipで表示
        if (!maskedTextBox1.MaskCompleted)
        {
            toolTip.Show("入力が不完全です。", maskedTextBox1, 0, -20, 2000); // 2秒間表示
            e.Cancel = true; // フォーカスを戻す
        }
    }
}

このコードでは、MaskedTextBoxの入力が不完全な場合にToolTipを使用してエラーメッセージを表示します。

ToolTipは指定した時間だけ表示され、ユーザーに対して視覚的なフィードバックを提供します。

これにより、ユーザーはどのようなエラーが発生しているのかを簡単に理解できます。

応用例

電話番号のバリデーション

電話番号のバリデーションは、特定の形式に従った入力を求めるために非常に重要です。

日本の一般的な電話番号形式(例: 03-1234-5678)を考慮したバリデーションを実装することができます。

以下は、電話番号のバリデーションを行うサンプルコードです。

using System.Text.RegularExpressions; // 正規表現を使用するための名前空間
partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
    }
    private void maskedTextBox1_Validating(object sender, CancelEventArgs e)
    {
        // 電話番号の正規表現パターン
        string pattern = @"^(0\d{1,4}-\d{1,4}-\d{4})$"; // 例: 03-1234-5678
        if (!Regex.IsMatch(maskedTextBox1.Text, pattern))
        {
            MessageBox.Show("電話番号の形式が正しくありません。");
            e.Cancel = true; // フォーカスを戻す
        }
    }
}

このコードでは、電話番号が 0X-XXXX-XXXX の形式であるかを確認し、形式が正しくない場合にはエラーメッセージを表示します。

郵便番号のバリデーション

郵便番号のバリデーションも重要な要素です。

日本の郵便番号は 123-4567 の形式であるため、この形式に従ったバリデーションを行います。

以下は、郵便番号のバリデーションを行うサンプルコードです。

using System.Text.RegularExpressions; // 正規表現を使用するための名前空間
partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
    }
    private void maskedTextBox1_Validating(object sender, CancelEventArgs e)
    {
        // 郵便番号の正規表現パターン
        string pattern = @"^\d{3}-\d{4}$"; // 例: 123-4567
        if (!Regex.IsMatch(maskedTextBox1.Text, pattern))
        {
            MessageBox.Show("郵便番号の形式が正しくありません。");
            e.Cancel = true; // フォーカスを戻す
        }
    }
}

このコードでは、郵便番号が XXX-XXXX の形式であるかを確認し、形式が正しくない場合にはエラーメッセージを表示します。

日付入力のバリデーション

日付の入力も重要なバリデーションの一つです。

特に、日付が正しい範囲内にあるかを確認することが求められます。

以下は、日付のバリデーションを行うサンプルコードです。

using System; // DateTimeを使用するための名前空間
partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent();
    }
    private void maskedTextBox1_Validating(object sender, CancelEventArgs e)
    {
        // 日付の形式を確認
        DateTime dateValue;
        if (!DateTime.TryParse(maskedTextBox1.Text, out dateValue))
        {
            MessageBox.Show("日付の形式が正しくありません。");
            e.Cancel = true; // フォーカスを戻す
        }
        else if (dateValue < new DateTime(1900, 1, 1) || dateValue > DateTime.Now)
        {
            MessageBox.Show("日付は1900年1月1日以降、現在の日付までである必要があります。");
            e.Cancel = true; // フォーカスを戻す
        }
    }
}

このコードでは、入力された日付が正しい形式であるかを確認し、さらに1900年1月1日以降、現在の日付までの範囲内であるかをチェックします。

条件に合わない場合にはエラーメッセージを表示し、フォーカスを戻します。

これにより、ユーザーは正しい日付を入力することができます。