Format プロパティ (GcTextBox)

入力可能な文字種を指定する書式を取得または設定します。

構文

Visual Basic (宣言)
C#

Public Property Format As String

public string Format {get; set;}

プロパティ値

以下のキーワードを組み合わせた文字列を指定します。全角文字が指定された場合は全角文字が、半角文字が指定された場合は半角文字がそれぞれ入力可能な文字種として指定されます。

全角	半角	説明
Ａ	A	大文字のアルファベット（A～Z）
ａ	a	小文字のアルファベット（a～z）
Ｋ	K	カタカナ（促音・拗音の小書き表記あり）
Ｎ	N	カタカナ（促音・拗音の小書き表記なし）
９	9	数字（0～9）
＃	#	数字および数字関連記号（0～9、+ - $ % \ , .）
＠	@	記号
Ｂ	B	２進数（0または1）
Ｘ	X	16進数（0～9、A～F、a-f）
Ｓ	S	空白文字
Ｊ	-	ひらがな（促音・拗音の小書き表記あり）
Ｇ	-	ひらがな（促音・拗音の小書き表記なし）
Ｚ	-	すべての全角文字
Ｔ	-	サロゲートペア文字
Ｄ	-	2バイト文字(サロゲートペア文字を除いた全角文字)
Ｉ	-	JIS X 0208文字で構成された文字
Ｍ	-	Shift JIS文字で構成された文字
Ｖ	-	IVS(Ideographic Variation Sequence)文字
-	H	すべての半角文字
-	^	指定した書式に含まれないすべての文字
-	\	エスケープ・シーケンス

既定値はstring.Emptyです。

解説

Format プロパティで設定した以外の文字種が入力されたときは、 InvalidInput イベントが発生します。

また、テキストコントロールへの入力を制御するために、Format プロパティのほかに次のプロパティが用意されています。

AutoConvert（入力文字列の自動変換）
MaxLengthUnit（入力可能な最大文字数の設定方法の指定）
MaxLength（入力可能な最大文字数の設定）

Text プロパティに渡す文字列は、 Format プロパティで設定した入力マスクと正確に一致する必要があります。一致しない場合には、キーボードで入力した内容またはコードで設定した内容は、 Text プロパティに反映されません。ただし、AutoConvert プロパティによって自動修正が可能な場合は除きます。また、Format プロパティを変更すると、Text プロパティは自動的に空の文字列に設定されます。

使用例

書式を設定した GcTextBox コントロールを作成するコード例を次に示します。この例では他に AutoConvert そして Format プロパティを使用して、特定の文字の入力を許可する GcTextBox コントロールを作成しています。

C#
Visual Basic

//  Please use the following namespace
//  using System.Windows.Forms;
//  using GrapeCity.Win.Editors;

public void InitializeTextBox()
{
    // Create an instance of a GcTextBox control.
    GcTextBox gcTextBox1 = new GcTextBox();

    // Allow the GcTextBox control to accept only upper case alphabet(A-Z) and SBCS space.
    gcTextBox1.Format = "AS";
    // The GcTextBox control will not try to convert invalid char to valid char automatically.
    gcTextBox1.AutoConvert = false;

    // Create an instance of a GcTextBox control.
    GcTextBox gcTextBox2 = new GcTextBox();
    // Accept upper and lower case alphabet, as well as the symbols. Except '#', '@' and '*' chars.
    gcTextBox2.Format = @"aA@^\#\@*";
    // The GcTextBox will try to convert the invalid char to valid char automatically.
    gcTextBox2.AutoConvert = true;
}

'  Please use the following namespace
'  Imports System.Windows.Forms
'  Imports GrapeCity.Win.Editors

Public Sub InitializeTextBox()
    ' Create an instance of a GcTextBox control.
    Dim gcTextBox1 As New GcTextBox()

    ' Allow the GcTextBox control to accept only upper case alphabet(A-Z) and SBCS space.
    gcTextBox1.Format = "AS"
    ' The GcTextBox control will not try to convert invalid char to valid char automatically.
    gcTextBox1.AutoConvert = False

    ' Create an instance of a GcTextBox control.
    Dim gcTextBox2 As New GcTextBox()
    ' Accept upper and lower case alphabet, as well as the symbols. Except '#', '@' and '*' chars.
    gcTextBox2.Format = "aA@^\#\@*"
    ' The GcTextBox will try to convert the invalid char to valid char automatically.
    gcTextBox2.AutoConvert = True
End Sub

参照

GcTextBox クラス
 GcTextBox メンバ
 AutoConvert プロパティ