Format プロパティ (GcMask)

入力用の文字列書式を示すMaskFormatオブジェクトを取得または設定します。

構文

Visual Basic (宣言)
C#

Public Property Format As MaskFormat

public MaskFormat Format {get; set;}

プロパティ値

既定値：GrapeCity.Web.Input.IMMask.MaskFormat("")

例外

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

解説

コントロールの入力マスク書式は、Formatプロパティが参照するMaskFormatオブジェクトを使って設定します。このオブジェクトのMaskFormat.Patternプロパティに正規表現のキーワード（メタ文字）を設定することで、マスクを作成します。

MaskFormat.Patternプロパティを空の文字列（""またはString.Empty）に設定すると、テキストコントロールのような入力が可能になります。

MaskFormatオブジェクトのMaskFormat.Patternプロパティでは、以下の表現が使用できます。

表現のタイプ	説明
8進数（ASCII）	ASCII文字を表現するときだけ使用します。「\040」のように、頭に0をつけて必ず３桁の数値で表現します。
16進数（ASCII）	ASCII文字を表現するときだけ使用します。「\x20」のように、\xに続いて必ず２桁の数値（頭に0を付ける）で表現します。
16進数（Unicode）	すべての文字を表現できます。「\u0020」のように、\uに続いて必ず４桁の数値（頭に0を付ける）で表現します。
キーワード	下表で説明するキーワード（メタ文字）です。
文字	キーワード以外の文字です。

コントロールの書式を設定するMaskFormat.Patternプロパティでは、以下のような正規表現を使用します。ここでは、キーワードを主要なものと補助的なものに分けて解説します。

主要なキーワード

半角	全角	説明
\A	\Ａ	大文字のアルファベットを表します。[A-Z]または[Ａ-Ｚ]と同等です。
\a	\ａ	小文字のアルファベットを表します。[a-z]または[ａ-ｚ]と同等です。
\D	\Ｄ	数字を表します。[0-9]または[０-９]と同等です。
\B	\Ｂ	2進数を表します。[0-1]または[０-１]と同等です。
\X	\Ｘ	16進数を表します。[0-9A-Fa-f]または[０-９Ａ-Ｆａ-ｆ]と同等です。
\W	\Ｗ	すべての英数字を表します。[a-zA-Z_0-9]または[ａ-ｚＡ-Ｚ＿０-９]と同等です。
\K	\Ｋ	カタカナ（促音・拗音の小書き表記あり）を表します。
\N	\Ｎ	カタカナ（促音・拗音の小書き表記あり）を表します。
\H	-	すべての半角文字を表します。
-	\Ｊ	ひらがな（促音・拗音の小書き表記あり）を表します。
-	\Ｇ	ひらがな（促音・拗音の小書き表記なし）を表します。
-	\Ｚ	すべての全角文字を表します。
-	\Ｔ	サロゲートペア文字を表します。
-	\Ｉ	JIS X 0208で構成された文字を表します。
-	\Ｍ	Shift JISで構成された文字を表します。
-	\Ｖ	IVS（Ideographic Variation Sequence）文字を表します。

補助的なキーワード

メタ文字	説明
[]	[]内の文字のどれか１つにマッチすることを表します。
^	[]内の先頭で使用し、その後に続く文字グループの補集合をあらわします。
-	[]内で使用し、文字の範囲を指定します。
()	()内の文字列のどれか１つにマッチすることを表します。
\|	()内で使用し、文字列間の区切り文字として機能します。
{n}	直前のキーワードのn回の繰り返しを表します。
{n,}	直前のキーワードのn回以上の繰り返しを表します。
{n,m}	直前のキーワードのn回以上でm回以下の繰り返しを表します。
*	直前のキーワードの0回以上の繰り返しを表します。{0,}と同等です。
+	直前のキーワードの1回以上の繰り返しを表します。{1,}と同等です。
?	直前のキーワードの0回または1回の繰り返しを表します。{0,1}と同等です。
\(Chr(92))	キーワードをリテラル文字として表示

正規表現の例

書式	表記例	説明
[]	A,a,ｱ,1,Ａ,ａ,あ,ア,１	すべての文字を表します。[\Ｚ\H]と同等です。
[^]		どの文字も当てはまりません。[^\Ｚ\H]と同等です。
[^\W]	1, A, a, あ	全角の英数文字以外を表します。
[\D^123]	4, 5, 6	1、2、3を除く半角の数字を表します。
[\Ｚ^\Ｔ]	あ、い、う	サロゲートペア文字を除くすべての全角文字を表します。
[Ａ-Ｚ]	Ａ, Ｂ, Ｃ, Ｘ, Ｙ, Ｚ	すべての全角大文字アルファベットを表します。\Ａと同等です。
[\H^a-z]	A, Z, 1, 9	小文字のアルファベットを除くすべての半角文字を表します。
[\u0000-Ｚ]	0, ９, a, Ｚ	範囲設定のときに異種の表現が使えます。
[\u0000\Kaeiou0-9]	ｱ, a, o, 0	異種の表現を組み合わせることが可能です。
[\Kaeiou0-9\-\\]	ｱ, a, o, 0	"-" と "\" をリテラル文字として扱う例です。
(A1\|B2\|C3)	A1, B2, C3	()内の文字列のどれか１つにマッチすることを表します。

旧式のプロパティ

MaskFormatクラスのNullプロパティとNonFocusNullプロパティは、8.0J以降で旧式（obsolate）のメンバとなりました。これらのプロパティと同等の機能を実現するには、GrapeCity.Web.Input.Core.BaseEditControl.Watermarkプロパティを使用して、未入力時の表示文字を設定します。

使用例

最初のサンプルコードは、Formatプロパティを使用して電話番号と郵便番号を入力するための書式を設定する方法を示します。

下のサンプルコードは、同じ設定をMaskFormatオブジェクトを明示的に生成することで行います。

Visual Basic
C#

' 以下はFormatプロパティを使って設定する例です。
' 電話番号を入力する書式を設定します。
GcMask1.Format.Pattern = "電話番号：\D{2,4}\(\D{2,4}\)\D{4}"

' 郵便番号を入力する書式を設定します。
GcMask2.Format.Pattern = "郵便番号：\D{3}-\D{4}"

// 以下はFormatプロパティを使って設定する例です。
// 電話番号を入力する書式を設定します。
GcMask1.Format.Pattern = "電話番号：\\D{2,4}\\(\\D{2,4}\\)\\D{4}";

// 郵便番号を入力する書式を設定します。
GcMask2.Format.Pattern = "郵便番号：\\D{3}-\\D{4}";

Visual Basic
C#

' 電話番号を入力する書式を設定します。
GcMask1.Format = New GrapeCity.Web.Input.IMMask.MaskFormat("電話番号：\D{2,4}\(\D{2,4}\)\D{4}")

' 郵便番号を入力する書式を設定します。
GcMask2.Format = New GrapeCity.Web.Input.IMMask.MaskFormat("郵便番号：\D{3}-\D{4}")

// 電話番号を入力する書式を設定します。
GcMask1.Format = new GrapeCity.Web.Input.IMMask.MaskFormat("電話番号：\\D{2,4}\\(\\D{2,4}\\)\\D{4}");

// 郵便番号を入力する書式を設定します。
GcMask2.Format = new GrapeCity.Web.Input.IMMask.MaskFormat("郵便番号：\\D{3}-\\D{4}");

参照

GcMask クラス
 GcMask メンバ