Format プロパティ (GcTextBox)

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

構文

Visual Basic (宣言)
C#

Public Property Format As String

public string Format {get; set;}

プロパティ値

既定値：String.Empty

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

例外

例外	解説
System.ArgumentException	無効なキーワードが設定されています。

解説

Formatプロパティで設定した以外の文字種が入力されたときは、GrapeCity.Web.Input.Core.BaseEditClientEvents.InvalidInputクライアントイベントが発生します。
また、テキストコントロールへの入力を制御するために、Formatプロパティのほかに次のプロパティが用意されています。

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

使用例

次のサンプルコードでは、半角および全角の文字種を許可しますが、スペースは半角スペースのみ許可します。

Visual Basic
C#

GcTextBox1.Format = "ＺHS"

GcTextBox1.Format = "ＺHS";

参照

GcTextBox クラス
 GcTextBox メンバ