TextBox

[C#] TextBoxでの文字数制限の設定方法

C#でTextBoxの文字数制限を設定するには、MaxLengthプロパティを使用します。

このプロパティに整数値を設定することで、TextBoxに入力できる最大文字数を指定できます。

例えば、textBox1.MaxLength = 10;とすることで、textBox1に入力できる文字数を10文字に制限します。

これにより、ユーザーがそれ以上の文字を入力しようとすると、追加の入力が無視されます。

MaxLengthプロパティは、Windows Formsアプリケーションで一般的に使用されます。

目次から探す

文字数制限の設定方法
文字数制限の応用
実装の注意点
まとめ

文字数制限の設定方法

MaxLengthプロパティの概要

C#のWindowsフォームアプリケーションにおいて、TextBoxコントロールにはMaxLengthプロパティがあります。

このプロパティを使用することで、ユーザーが入力できる文字数を制限することができます。

MaxLengthプロパティは、整数値を設定することで、最大文字数を指定します。

例えば、MaxLengthを5に設定すると、ユーザーは最大で5文字までしか入力できなくなります。

MaxLengthプロパティの設定方法

MaxLengthプロパティは、TextBoxコントロールのプロパティとして簡単に設定できます。

以下のサンプルコードでは、MyFormクラス内でTextBoxのMaxLengthを設定する方法を示します。

public partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // TextBoxのMaxLengthプロパティを設定
        TextBox myTextBox = new TextBox();
        myTextBox.MaxLength = 10; // 最大文字数を10に設定
        this.Controls.Add(myTextBox); // フォームにTextBoxを追加
    }
}

このコードでは、myTextBoxというTextBoxを作成し、MaxLengthプロパティを10に設定しています。

これにより、ユーザーは最大で10文字まで入力できるようになります。

MaxLengthプロパティの使用例

MaxLengthプロパティを使用する具体的な例を以下に示します。

例えば、ユーザー名を入力するTextBoxに対して、最大文字数を15に設定する場合のコードは次の通りです。

public partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        // ユーザー名用のTextBoxを作成
        TextBox usernameTextBox = new TextBox();
        usernameTextBox.MaxLength = 15; // 最大文字数を15に設定
        this.Controls.Add(usernameTextBox); // フォームにTextBoxを追加
    }
}

この例では、usernameTextBoxに最大15文字の制限を設けています。

これにより、ユーザーは15文字を超えるユーザー名を入力できなくなります。

文字数制限の応用

入力制限のカスタマイズ

MaxLengthプロパティを使用することで、基本的な文字数制限を設定できますが、さらにカスタマイズした入力制限を行うことも可能です。

例えば、特定の文字種(英数字のみ、ひらがなのみなど)を制限する場合、KeyPressイベントを利用して、入力を制御することができます。

以下のサンプルコードでは、英数字のみを許可するTextBoxの実装例を示します。

public partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        TextBox alphanumericTextBox = new TextBox();
        alphanumericTextBox.KeyPress += AlphanumericTextBox_KeyPress; // イベントハンドラを追加
        this.Controls.Add(alphanumericTextBox); // フォームにTextBoxを追加
    }
    private void AlphanumericTextBox_KeyPress(object sender, KeyPressEventArgs e)
    {
        // 入力が英数字でない場合、入力を無効にする
        if (!char.IsControl(e.KeyChar) && !char.IsLetterOrDigit(e.KeyChar))
        {
            e.Handled = true; // 入力を無効にする
        }
    }
}

このコードでは、KeyPressイベントを使用して、英数字以外の文字が入力された場合にその入力を無効にしています。

文字数制限とバリデーション

文字数制限を設けることは、ユーザーの入力を適切に管理するための重要な手段ですが、バリデーションと組み合わせることで、より堅牢なアプリケーションを作成できます。

例えば、TextBoxに入力された文字数が制限を超えた場合に、エラーメッセージを表示することができます。

以下のサンプルコードでは、ボタンをクリックした際にバリデーションを行う例を示します。

public partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        TextBox inputTextBox = new TextBox();
        Button validateButton = new Button();
        validateButton.Text = "確認"; // ボタンのテキスト
        validateButton.Click += ValidateButton_Click; // イベントハンドラを追加
        this.Controls.Add(inputTextBox); // フォームにTextBoxを追加
        this.Controls.Add(validateButton); // フォームにボタンを追加
    }
    private void ValidateButton_Click(object sender, EventArgs e)
    {
        TextBox inputTextBox = (TextBox)this.Controls[0]; // TextBoxを取得
        if (inputTextBox.Text.Length > 10) // 最大文字数を10とする
        {
            MessageBox.Show("文字数は10文字以内で入力してください。"); // エラーメッセージを表示
        }
    }
}

このコードでは、ボタンをクリックした際にTextBoxの文字数をチェックし、制限を超えている場合にエラーメッセージを表示します。

文字数制限とエラーメッセージの表示

ユーザーが入力した内容が制限を超えた場合、適切なエラーメッセージを表示することは、ユーザーエクスペリエンスを向上させるために重要です。

エラーメッセージは、ユーザーが何を修正すべきかを明確に伝える役割を果たします。

以下のサンプルコードでは、TextBoxのLeaveイベントを使用して、フォーカスが外れた際に文字数をチェックし、エラーメッセージを表示する例を示します。

public partial class MyForm : Form
{
    public MyForm()
    {
        InitializeComponent(); // フォームの初期化
        TextBox inputTextBox = new TextBox();
        inputTextBox.Leave += InputTextBox_Leave; // イベントハンドラを追加
        this.Controls.Add(inputTextBox); // フォームにTextBoxを追加
    }
    private void InputTextBox_Leave(object sender, EventArgs e)
    {
        TextBox inputTextBox = (TextBox)sender; // TextBoxを取得
        if (inputTextBox.Text.Length > 10) // 最大文字数を10とする
        {
            MessageBox.Show("文字数は10文字以内で入力してください。"); // エラーメッセージを表示
            inputTextBox.Focus(); // フォーカスを戻す
        }
    }
}

このコードでは、TextBoxからフォーカスが外れた際に文字数をチェックし、制限を超えている場合にはエラーメッセージを表示し、再度フォーカスを戻しています。

これにより、ユーザーは入力内容を修正することができます。