C# TextBox.MaxLength プロパティ

このサイトはプロモーションを含みます

2024年9月14日

C#でWindowsフォームアプリケーションを開発する際、ユーザーからの入力を制御することは非常に重要です。特に、テキストボックスに入力できる文字数を制限したい場面がよくあります。例えば、ユーザー名やパスワードの最大長を設定したり、固定長のコードを入力させたりする場合などです。このような制御を簡単に実現できるのが、TextBoxコントロールのMaxLengthプロパティです。

TextBox.MaxLength プロパティとは

MaxLengthプロパティは、テキストボックスに入力できる最大文字数を指定します。このプロパティを設定することで、ユーザーが指定された文字数以上の入力をしようとしても、自動的に入力が制限されます。

MaxLength プロパティの基本的な使い方

以下に、MaxLengthプロパティを使用する基本的なコード例を示します：

using System;
using System.Windows.Forms;

public partial class Form1 : Form
{
    private TextBox usernameTextBox;

    public Form1()
    {
        InitializeComponent();
        CreateLimitedTextBox();
    }

    private void CreateLimitedTextBox()
    {
        usernameTextBox = new TextBox
        {
            Location = new System.Drawing.Point(10, 10),
            Size = new System.Drawing.Size(200, 20),
            MaxLength = 10 // 最大10文字に制限
        };

        this.Controls.Add(usernameTextBox);

        // ラベルを追加して説明を表示
        Label infoLabel = new Label
        {
            Location = new System.Drawing.Point(10, 40),
            Size = new System.Drawing.Size(200, 20),
            Text = "ユーザー名は最大10文字です。"
        };

        this.Controls.Add(infoLabel);
    }
}

このコードの主なポイントは以下の通りです：

MaxLength = 10 を設定することで、テキストボックスに入力できる最大文字数を10に制限しています。
ユーザーが11文字目以降を入力しようとしても、自動的に入力が無視されます。
この制限は、キーボードからの入力だけでなく、コピー＆ペーストの操作にも適用されます。

MaxLength プロパティの活用例

MaxLengthプロパティは、様々な場面で活用できます。以下にいくつかの例を示します：

パスワード入力フィールド：セキュリティポリシーに基づいて最大長を設定

passwordTextBox.MaxLength = 16;

2.郵便番号入力フィールド：固定長のコードを入力させる

zipCodeTextBox.MaxLength = 7; // 日本の郵便番号（ハイフンなし）

3.コメント入力欄：データベースのフィールド長に合わせて制限

commentTextBox.MaxLength = 500;

MaxLength プロパティと文字数表示の組み合わせ

ユーザーの利便性を高めるために、現在の入力文字数と最大文字数を表示することもできます。以下は、その実装例です：

private TextBox commentTextBox;
private Label charCountLabel;

private void CreateCommentBox()
{
    commentTextBox = new TextBox
    {
        Location = new System.Drawing.Point(10, 10),
        Size = new System.Drawing.Size(300, 100),
        Multiline = true,
        MaxLength = 200
    };

    charCountLabel = new Label
    {
        Location = new System.Drawing.Point(10, 120),
        Size = new System.Drawing.Size(200, 20),
        Text = "0 / 200 文字"
    };

    commentTextBox.TextChanged += CommentTextBox_TextChanged;

    this.Controls.Add(commentTextBox);
    this.Controls.Add(charCountLabel);
}

private void CommentTextBox_TextChanged(object sender, EventArgs e)
{
    charCountLabel.Text = $"{commentTextBox.Text.Length} / {commentTextBox.MaxLength} 文字";
}

この例では、テキストが変更されるたびに文字数を更新し、ユーザーに現在の入力状況を視覚的に伝えています。