書式の設定

コンボコントロールのテキストボックス部の入力書式の設定について説明します。

書式の設定

テキストボックスは、書式を設定することで入力可能な文字種を制限することができます。入力可能な文字種はFormat プロパティで制限することができます。Format プロパティに設定できるキーワードは、次の表のとおりです。また、ここで指定された以外の文字種が入力されると、InvalidInput イベントが発生します。

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

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

文字種の設定は、デザイン画面からは専用の「書式の設定」エディタを使用して容易に設定できます。このエディタは以下のいずれかの方法で起動します。

プロパティページの「書式設定」を選択
コントロールのスマートタグから「書式の設定...」を選択
プロパティウィンドウのFormatプロパティをアクティブにした時に表示される「…」ボタンを押下

以下に、入力可能な文字種を設定する具体例を示します。

次のコードは、半角大文字のアルファベット（A～Z）と２進数（0, 1）のみを許可します。

Visual Basic
C#

GcComboBox1.Format = "AB"

gcComboBox1.Format = "AB";

次の例では、半角大文字のアルファベットと数字（0～9）が入力可能になります。キーワード"X"で指定した16進数は、別のキーワードの"A"と"9"に含まれているので、無視されます。

Visual Basic
C#

GcComboBox1.Format = "AX9"

gcComboBox1.Format = "AX9";

下のコードでは、すべての半角文字の入力が許可されます。キーワード"AaK9"で指定した文字種は"H"に包含されているので、この部分は無視されます。

Visual Basic
C#

GcComboBox1.Format = "AaK9H"

gcComboBox1.Format = "AaK9H";

次に示す２つの例は、どちらもスペースを含むすべての文字種を許可するものです。デフォルトでは、最初の例のように設定されていますので、２つ目の例のようにキーワード"ＺH"を指定しなくても同じ動作となります。

Visual Basic
C#

GcComboBox1.Format = ""
GcComboBox1.AllowSpace = GrapeCity.Win.Editors.AllowSpace.Both

GcComboBox1.Format = "ＺH"
GcComboBox1.AllowSpace = GrapeCity.Win.Editors.AllowSpace.Both

gcComboBox1.Format = "";
gcComboBox1.AllowSpace = GrapeCity.Win.Editors.AllowSpace.Both;

gcComboBox1.Format = "ＺH";
gcComboBox1.AllowSpace = GrapeCity.Win.Editors.AllowSpace.Both;

以下の２つのコードは、すべての文字種の入力を拒否します。スペースの入力も許可されません。この例が示すように、キーワード"^"は、その後に記述されたキーワードの補集合を表します。

Visual Basic
C#

GcComboBox1.Format = "^"
GcComboBox1.AllowSpace = GrapeCity.Win.Editors.AllowSpace.None

GcComboBox1.Format = "^ＺH"
GcComboBox1.AllowSpace = GrapeCity.Win.Editors.AllowSpace.None

gcComboBox1.Format = "^";
gcComboBox1.AllowSpace = GrapeCity.Win.Editors.AllowSpace.None;

gcComboBox1.Format = "^ＺH";
gcComboBox1.AllowSpace = GrapeCity.Win.Editors.AllowSpace.None;

また、入力可能な文字種から特定の文字種を除外することもできます。次のコードはすべての全角文字からサロゲート文字だけを除外します。

Visual Basic
C#

GcComboBox1.Format = "Ｚ^Ｔ"

gcComboBox1.Format = "Ｚ^Ｔ";

特定の文字を書式に設定することも可能です。記号から「^、@、\、$」の4文字を除外するには以下のように記述します。

Visual Basic
C#

GcComboBox1.Format = "@^\^\@\\$"

gcComboBox1.Format = "@^\\^\\@\\\\$";

文字列の自動変換

AutoConvert プロパティをTrueに設定すると、Format プロパティの設定内容に基づいて、変換可能な文字はすべて自動的に変換されます。たとえば、Format プロパティで"A"キーワードが設定されていると、小文字を入力しても自動的に大文字に変換されます。また、全角文字だけが許可されている場合は、入力された半角文字は全角文字に変換されます。

コントロール内部で行われる自動変換の手順を以下に示します。

小文字から大文字、または大文字から小文字への変換を行います。
手順１の変換が行われない場合、全角から半角、または半角から全角への変換を行います。
手順２の変換が行われない場合、全角大文字から半角小文字、全角小文字から半角大文字、半角大文字から全角小文字、半角小文字から全角大文字のいずれかの変換を行います。

半角カタカナ、全角カタカナ、およびひらがなは、次のように変換されます。

半角カタカナは全角カタカナに変換。変換できない場合はひらがなに変換。
全角カタカナは半角カタカナに変換。変換できない場合はひらがなに変換。
ひらがなは全角カタカナに変換。変換できない場合は半角カタカナに変換。

Formatプロパティに"^Ｖ"が設定された場合、IVS文字およびIVSの親となる漢字(以下、親字)は以下のように変換されます。

"^Ｖ"（IVS文字を除外する）
IVS文字	親字に変換されます。
親字	そのまま入力されます。

スペース入力の制御

AllowSpace プロパティは、Format プロパティの設定に依存せずに入力可能なスペースの種類を設定します。AllowSpace プロパティがAllowSpace.Wide に設定されている場合、Format プロパティにキーワード"H"のみが設定されていても、コントロールには全角のスペースのみ入力可能です。また、同様にAllowSpace プロパティがAllowSpace.Narrow に設定されている場合、キーワード"Ｚ"のみが設定されていても、半角のスペースだけが入力可能になります。

AllowSpaceの値	説明
Both	半角、全角の両方のスペースが入力可能。
Narrow	半角のスペースのみ入力可能。
Wide	全角のスペースのみ入力可能。
None	スペースの入力はできません。

既存のテキストにスペースが含まれているときに、AllowSpace をNoneに設定すると、それらのスペースがすべて削除されます。

参照