リサイズはクリックかドラッグ

フィールドオブジェクトによる書式設定

このセクションでは、フィールドオブジェクトによる書式設定について説明します。

概要

マスクコントロールでは、次の３種類のフィールドが用意されており、これらのフィールドオブジェクトを使って書式を設定することができます。

これらのフィールドオブジェクトを MaskFieldCollection に追加するには、Add メソッドまたは、AddRange メソッドを使用します。

以下のサンプルコードは、マスクコントロールに郵便番号書式を設定する例です。AddRange メソッドを使用して MaskFieldCollection にフィールドを追加しています。

コピー
using GrapeCity.Windows.InputMan.Fields;

// フィールドオブジェクトを作成します。 
MaskPatternField maskPatternField1 = new MaskPatternField("\\D", 3, 3);
MaskLiteralField maskLiteralField1 = new MaskLiteralField("-");
MaskPatternField maskPatternField2 = new MaskPatternField("\\D", 4, 4);

// フィールドをコレクションに追加してコントロールに書式を設定します。 
GcMask1.FieldSet.Fields.AddRange(new MaskField[] {maskPatternField1, maskLiteralField1, maskPatternField2});

フィールドオブジェクトを MaskFieldCollection から削除するには、Remove メソッドまたは、RemoveAt メソッドを使用します。

以下のサンプルコードは、MaskFieldCollection の先頭のフィールドを削除する例です。

コピー
// コレクションの先頭のオブジェクトを削除します。 
GcMask1.FieldSet.Fields.RemoveAt(0);
フィールドオブジェクト

ここでは、マスクコントロールに設定可能な３種類のフィールドについて解説します。

パターンフィールド（MaskPatternField）

パターンフィールド（MaskPatternField）は、マスクコントロールの最も特徴的な機能である入力マスクを設定するフィールドです。パターンフィールドで最も重要なプロパティは Pattern プロパティで、入力マスクを定義するためのキーワードを設定することができます。

プロパティ説明
AutoConvertPattern プロパティで設定された文字種に自動で変換するかどうかを設定します。
MaxLengthPattern プロパティで設定されたキーワードを繰り返す最大文字数を設定します。
MinLengthPattern プロパティで設定されたキーワードを繰り返す最小文字数を設定します。
Pattern入力マスクを定義する正規表現のキーワード（メタ文字）を設定します。
PromptCharプロンプト文字を設定します。

Pattern プロパティで使用可能な表現のタイプ

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

Pattern プロパティで使用可能なキーワード

1. 主要なキーワード

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

半角文字と全角文字は、その文字の Shift-JIS コードを使って識別されます。

2. 補助的なキーワード

メタ文字説明
^その後に続く文字グループの補集合をあらわします。
-文字の範囲を指定します。
\（Chr(92)）キーワードをリテラル文字として表示

以下に、パターンフィールドでの書式設定の例を示します。

PatternMaxLengthMinLength表示例説明
\Ｚ050あア漢１Ａａ０文字以上、50 文字以下のすべての全角を表します。
\D351234３文字以上、５文字以下のすべての半角数字を表します。
1-3,a-c,A-C1010123410 文字の 1,2,3,a,b,c,A,B,C を表します。
A-Z065535ABCDE半角大文字アルファベットを表します。\A と同等です。
H^a-z06553512ABｱｲｳ小文字のアルファベットを除くすべての半角文字を表します。
^\T065535あア漢１Ａａサロゲート ぺア文字を除くすべての文字を表します。

リテラルフィールド（MaskLiteralField）

リテラルフィールド（MaskLiteralField）は、コントロールに表示するリテラル文字を設定します。リテラルフィールド固有のプロパティは以下の Text プロパティのみです。

プロパティ説明
Text表示するリテラル文字を設定します。

列挙型フィールド（MaskEnumerationField）

列挙型フィールド（MaskEnumerationField）は、設定された列挙値の項目から選択して文字列をコントロールに表示することができます。このフィールドには、列挙値で設定された文字列以外の文字は入力できません。

列挙値に設定された文字列を選択するには、コントロールのスピン機能によって順次表示させるか、列挙型フィールドにドロップダウンリストを表示してリストから選択することができます。

ドロップダウンリストはフィールド単位で表示されるため、１つのコントロールに複数の列挙型フィールドを設定すれば、複数のドロップダウンリストを持ったコントロールを作成することもできます。

プロパティ説明
AllowDropDownOpenフィールドのドロップダウン機能を有効にするかどうかを設定します。
AutoConvert列挙値に含まれない値が入力されたときに、値を項目に自動で変換するかどうかを設定します。
AutoOpenDropDownフィールドにキャレットが移動されたときに、自動でドロップダウンリストを表示するかどうかを設定します。
Items列挙値を設定します。
PromptCharプロンプト文字を設定します。
SpinIncrementスピンによって列挙値を増減させる項目の数を設定します。
参照