テキストボックスでタブ文字の幅（Tabのサイズ）を設定する [C#] TextBox

Windowsフォームのテキストボックス（System.Windows.Forms名前空間にあるTextBoxクラスとRichTextBoxクラス）のタブ文字のサイズ（幅）を設定する方法を紹介します。

テキストボックスにタブ文字を入力できるようにした際のタブ文字の幅は、デフォルト（既定値）では8文字になっています。これを任意の文字幅に設定できるようにします。

WindowsフォームのTextBoxコントロールには、タブ文字の幅を設定するためのプロパティは用意されていません。
RichTextBoxコントロールには、SelectionTabsというタブの位置を設定することができるプロパティがあります。
しかしこれは、RichTextBoxコントロール内のタブストップの絶対位置を取得または設定するもので、タブの位置をピクセル単位の数値で指定するものです。
Selectionという名前からも想像がつくように、現在選択されているテキストの各タブの間隔を格納している配列を操作するプロパティなので、設定するためにはいったんテキストを選択しなければなりません。しかも、配列の数は32個までという制限もあります。

今回ご紹介するタブ文字の幅を設定する方法であれば、選択文字や設定数の制限などなく自由に設定できます。

1 タブ文字の幅を設定するWindows API
2 宣言したメソッドの使用
3 サンプルプログラム

タブ文字の幅を設定するWindows API

Windowsフォームのテキストボックスには、タブ文字の幅を設定するためのプロパティがありませんので、Windows API（Win32 API）を利用します。
Windows APIを利用する際は、使用するライブラリ（dll）をインポートする属性を指定して、使用するメソッドを宣言します。

// Windows APIを使うための宣言
[System.Runtime.InteropServices.DllImport("dllName")]
static extern IntPtr MethodName(ParameterType1 parameterName1, ParameterType2 parameterName2, ...);

// Windows APIを使うための宣言

[System.Runtime.InteropServices.DllImport("dllName")]

static extern IntPtr MethodName(ParameterType1 parameterName1, ParameterType2 parameterName2, ...);

テキストボックスのタブ文字の幅を設定するためには「user32.dll」の「SendMessage」メソッドを使用しますので、以下のように宣言します。

// User32.dllをインポートしてWin32APIのSendMessageメソッドを定義
[System.Runtime.InteropServices.DllImport("user32.dll")]
static extern IntPtr SendMessage(IntPtr hWnd, int msg, int wParam, int[] lParam);

// User32.dllをインポートしてWin32APIのSendMessageメソッドを定義

[System.Runtime.InteropServices.DllImport("user32.dll")]

static extern IntPtr SendMessage(IntPtr hWnd, int msg, int wParam, int[] lParam);

参考
SendMessage function
EM_SETTABSTOPS message

宣言したメソッドの使用

宣言したWindows APIのメソッドは、.NET Frameworkの他のクラスのメソッドと同様に使用できます。

// タブ文字の幅を設定するメソッドを使用する
SendMessage(
    textBox.Handle,
    203,
    1,
    new int[] { 16 }
);

// タブ文字の幅を設定するメソッドを使用する

SendMessage(

textBox.Handle,

203,

new int[] { 16 }

);

1つ目のパラメーターのhWndには、タブ文字の幅を設定するテキストボックスのウィンドウハンドルを指定します。
2つ目のパラメーターのmsgには、203を指定します。
3つ目のパラメーターのwParamには、1を指定します。
4つ目のパラメーターのlParamには、設定するタブ文字の幅を要素を1つ持つ配列で指定します。

タブ文字の幅は文字数ではなく、文字数×4の値を指定します。例えばタブ文字の幅を4文字分にするのであれば、4×4＝16を指定することになります。

サンプルプログラム

サンプルとしてテキストボックスのタブ文字の幅を画面で設定できるプログラムを作成します。

ユーザーインターフェース

フォームにはテキストを編集するテキストボックス（textBox1）とタブ文字の幅などを設定するコントロールを配置するパネル（panel1）を配置します。
パネルの中には、タブ文字の幅を指定するテキストボックス（numericUpDown1）、フォントを設定するボタン（button1）、タブ文字の幅を設定するボタン（button2）を配置します。

ソースコード

using System;
using System.Drawing;
using System.Windows.Forms;

namespace WindowsFormsApp1
{
    public partial class Form1 : Form
    {
        // コンストラクタ
        public Form1()
        {
            InitializeComponent();

            // テキストボックスの設定
            // タブ文字を入力可能に設定
            this.textBox1.AcceptsTab = true;
            // 複数行入力可能に設定
            this.textBox1.Multiline = true;
            // 自動改行しないように設定
            this.textBox1.WordWrap = false;
            // 垂直、水平の両方のスクロールバーを表示
            this.textBox1.ScrollBars = ScrollBars.Both;
            // フォームにドッキング
            this.textBox1.Dock = DockStyle.Fill;
            // フォントをＭＳ ゴシック 10ポイントに設定
            this.textBox1.Font = new Font("ＭＳ ゴシック", 10f);

            // フッター部のパネルをフォームの下部にドッキングするように設定
            this.panel1.Dock = DockStyle.Bottom;
            
            // タブ幅を入力するテキストボックスを右揃えにする
            this.numericUpDown1.TextAlign = HorizontalAlignment.Right;

            // ボタンクリックのイベント
            this.button1.Click += Button1_Click;
            this.button2.Click += Button2_Click;
        }

        // フォントボタンクリック時のイベントメソッド
        private void Button1_Click(object sender, EventArgs e)
        {
            try
            {
                // フォントダイアログボックスを表示してフォントを設定
                using (FontDialog fontDialog = new FontDialog())
                {
                    // テキストボックスのフォントをダイアログボックスに設定
                    fontDialog.Font = this.textBox1.Font;

                    // ダイアログボックスを表示
                    DialogResult dialogResult = fontDialog.ShowDialog(this);
                    if (dialogResult == DialogResult.Cancel)
                    {
                        return;
                    }
                    // 選択されたフォントをテキストボックスに設定
                    this.textBox1.Font = fontDialog.Font;
                }
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }

        // タブ幅設定ボタンクリック時のイベントメソッド
        private void Button2_Click(object sender, EventArgs e)
        {
            try
            {
                // テキストボックスからタブ幅（文字数）を取得
                int length = Convert.ToInt32(this.numericUpDown1.Value);

                // Windows APIのメソッドに指定するタブ幅を取得
                int tabWidth = length * 4;

                // 定義したSetTabWidthメソッドでタブ幅を設定
                this.SetTabWidth(this.textBox1, tabWidth);
            }
            catch (Exception ex)
            {
                MessageBox.Show(ex.Message);
            }
        }

        #region タブ文字数の設定

        // User32.dllをインポートしてWin32APIのSendMessageメソッドを定義
        [System.Runtime.InteropServices.DllImport("user32.dll")]
        private static extern IntPtr SendMessage(IntPtr hWnd, int msg, int wParam, int[] lParam);

        // タブストップを表す定数 (203)
        private const int EM_SETTABSTOPS = 0x00CB;
        
        // タブ幅を設定する
        private void SetTabWidth(TextBox textBox, int tabWidth)
        {
            // Win32APIのSendMessageメソッドでタブストップ（タブ幅）を設定
            SendMessage(textBox.Handle, EM_SETTABSTOPS, 1, new int[] { tabWidth });
        }

        #endregion
    }
}

100

101

102

103

104

using System;

using System.Drawing;

using System.Windows.Forms;

namespace WindowsFormsApp1

{

public partial class Form1 : Form

{

// コンストラクタ

public Form1()

{

InitializeComponent();

// テキストボックスの設定

// タブ文字を入力可能に設定

this.textBox1.AcceptsTab = true;

// 複数行入力可能に設定

this.textBox1.Multiline = true;

// 自動改行しないように設定

this.textBox1.WordWrap = false;

// 垂直、水平の両方のスクロールバーを表示

this.textBox1.ScrollBars = ScrollBars.Both;

// フォームにドッキング

this.textBox1.Dock = DockStyle.Fill;

// フォントをＭＳゴシック 10ポイントに設定

this.textBox1.Font = new Font("ＭＳゴシック", 10f);

// フッター部のパネルをフォームの下部にドッキングするように設定

this.panel1.Dock = DockStyle.Bottom;

// タブ幅を入力するテキストボックスを右揃えにする

this.numericUpDown1.TextAlign = HorizontalAlignment.Right;

// ボタンクリックのイベント

this.button1.Click += Button1_Click;

this.button2.Click += Button2_Click;

}

// フォントボタンクリック時のイベントメソッド

private void Button1_Click(object sender, EventArgs e)

{

try

{

// フォントダイアログボックスを表示してフォントを設定

using (FontDialog fontDialog = new FontDialog())

{

// テキストボックスのフォントをダイアログボックスに設定

fontDialog.Font = this.textBox1.Font;

// ダイアログボックスを表示

DialogResult dialogResult = fontDialog.ShowDialog(this);

if (dialogResult == DialogResult.Cancel)

{

return;

}

// 選択されたフォントをテキストボックスに設定

this.textBox1.Font = fontDialog.Font;

}

catch (Exception ex)

{

MessageBox.Show(ex.Message);

}

// タブ幅設定ボタンクリック時のイベントメソッド

private void Button2_Click(object sender, EventArgs e)

{

try

{

// テキストボックスからタブ幅（文字数）を取得

int length = Convert.ToInt32(this.numericUpDown1.Value);

// Windows APIのメソッドに指定するタブ幅を取得

int tabWidth = length * 4;

// 定義したSetTabWidthメソッドでタブ幅を設定

this.SetTabWidth(this.textBox1, tabWidth);

}

catch (Exception ex)

{

MessageBox.Show(ex.Message);

}

#region タブ文字数の設定

// User32.dllをインポートしてWin32APIのSendMessageメソッドを定義

[System.Runtime.InteropServices.DllImport("user32.dll")]

private static extern IntPtr SendMessage(IntPtr hWnd, int msg, int wParam, int[] lParam);

// タブストップを表す定数 (203)

private const int EM_SETTABSTOPS = 0x00CB;

// タブ幅を設定する

private void SetTabWidth(TextBox textBox, int tabWidth)

{

// Win32APIのSendMessageメソッドでタブストップ（タブ幅）を設定

SendMessage(textBox.Handle, EM_SETTABSTOPS, 1, new int[] { tabWidth });

}

#endregion

}

プログラムの実行

作成したプログラムをビルドして実行（デバッグ）します。

タブ文字を入力します。
デフォルト（既定値）では8文字分の幅がとられています。

タブ文字の幅を4文字にします。

「タブ幅変更」ボタンをクリックしてタブ文字の幅を設定します。

タブ文字の幅が4文字分になりました。