テキストコントロールでは、入力可能な文字数やパスワード入力を設定することが可能です。ここではテキストコントロールが提供する入力機能について解説します。
テキストコントロールは、Format プロパティにより書式を設定することで入力可能な文字種を制限することができます。また、AutoConvert プロパティを使用して指定の書式に自動的に変換することも可能です。
テキストコントロールに設定可能な文字種等の詳細については、「書式の設定」で解説します。
MaxLengthUnit プロパティを使えば、MaxLength プロパティでコントロールへの入力可能文字数を設定する際に文字のカウント方法を指定することができます。MaxLengthUnit プロパティは、LengthUnit 列挙体を使用して次の3つ値を設定できます。
| MaxLengthUnitの値 | 説明 |
|---|---|
| Char | 文字単位でカウントしますが、サロゲート ぺア文字やIVS(Ideographic Variation Sequence)文字の異体字セレクタ(Variation Selector)は2文字としてカウントされます。 |
| Byte | バイト単位で文字をカウントします。 |
| TextElement | 文字単位でカウントします。サロゲート ぺア文字やIVS文字は1文字としてカウントされます。 |
なお、バイト単位の処理では、各文字のバイト数を識別に使用するエンコードは、MaxLengthCodePage プロパティで設定します。MaxLengthCodePage プロパティに設定可能なコードページのIDは、
System.Text.Encoding クラスのトピックに記載されている表の値です。
次のサンプルコードは、バイト数の識別にShift-JIS（コードページ ID :932）を使用する例です。
GcTextBox1.MaxLength = 5 GcTextBox1.MaxLengthUnit = GrapeCity.Win.Editors.LengthUnit.Byte GcTextBox1.MaxLengthCodePage = 932
gcTextBox1.MaxLength = 5; gcTextBox1.MaxLengthUnit = GrapeCity.Win.Editors.LengthUnit.Byte; gcTextBox1.MaxLengthCodePage = 932;
IVS文字はIVSの親となる漢字(以下、親字)の文字コードの後ろに異体字セレクタが付加された構造のため、MaxLengthプロパティの設定値によっては異体字セレクタが削除される場合があります。
以下はMaxLengthプロパティを「8」に設定し、親字「噌」を持つIVS文字「
」を入力可能な最大文字数を入力した場合の動作例です。
| MaxLengthUnitの値 | 動作例 |
|---|---|
| Char | 「」は親字1文字、異体字セレクタ2文字の合計3文字としてカウントされます。よって、3文字目は親字のみの1文字が入力され、異体字セレクタ以降は削除されます。 |
| Byte | 「」は親字2バイト、異体字セレクタ4バイトの合計6バイトとしてカウントされます。よって、2文字目は親字のみの2バイトが入力され、異体字セレクタ以降は削除されます。 |
| TextElement | IVS文字は1文字としてカウントされるため、8文字のIVS文字がすべて入力されます。 |
なお、SelectionStart プロパティとSelectionLength プロパティは、MaxLengthUnit プロパティの設定にかかわらず MaxLengthUnit.Char でカウントした結果と同じ文字単位で処理されます。
AcceptsCrLf プロパティを使用してクリップボードへ改行を含む文字列をコピー、または貼り付けた場合の改行コードの扱いを設定できます。AcceptsCrLf プロパティは、CrLfMode 列挙体を使用して次の値を設定できます。
| AcceptsCrLfの値 | 説明 |
|---|---|
| NoControl | 改行コードはそのままでコピー、貼り付けを行います。 |
| Filter | 全ての改行コードを削除しコピー、貼り付けを行います。 |
| Cut | 最初の改行コード以降の文字列を削除します。標準コントロールと同じ動作です。 |
AcceptsTabChar プロパティを使用してクリップボードへタブ文字を含む文字列をコピー、または貼り付けた場合のタブ文字の扱いを設定できます。AcceptsTabChar プロパティは、TabCharMode 列挙体を使用して次の値を設定できます。
| AcceptsTabCharの値 | 説明 |
|---|---|
| NoControl | タブ文字はそのままでコピー、貼り付けを行います。 |
| Filter | 全てのタブ文字を削除しコピー、貼り付けを行います。 |
| Cut | 最初のタブ文字以降の文字列を削除します。 |
 |
AcceptsTabChar プロパティは、複数行（MultilineプロパティがTrue）の場合は有効になりません。 |
以下のいずれかの設定を行うと、テキストコントロールはパスワード専用の入力フォームとして動作します。
- PasswordChar プロパティにパスワード文字を設定する
- UseSystemPasswordChar プロパティをTrueに設定する
また、PasswordRevelationMode プロパティを使用すると入力中のパスワード文字列を一時的に表示することが可能です。PasswordRevelationMode プロパティに設定可能な値は以下のとおりです。
| PasswordRevelationModeの値 | 説明 |
|---|---|
| None | パスワード文字列を表示しません。 |
| ShowEyeButton | パスワードを入力すると、コントロールの右端に目のアイコンが表示されこのアイコンのクリックでパスワード文字列を表示します。 |
| ShowLastTypedChar | 最後に入力した文字だけ数秒間表示します。 |
PasswordStrengthプロパティに設定を行うと、入力された値のパスワードとしての強度をチェックすることができます。
PasswordStrengthプロパティには以下のプロパティが含まれます。
| PasswordStrengthプロパティ | 説明 |
|---|---|
| Enable | パスワード強度チェック機能が有効か指定します。 |
| MaxLength | パスワードの最大長を指定します。 |
| MinLength | パスワードの最小長を指定します。 |
| LowerCaseVerify | 小文字を含む必要があるか指定します。 |
| UpperCaseVerify | 大文字を含む必要があるか指定します。 |
| NumberVerify | 数値を含む必要があるか指定します。 |
| SymbolVerify | 記号を含む必要があるか指定します。 |
| PasswordLine | パスワードのチェック結果を下線で通知します。下線の太さや各チェック結果に対する色を指定します。 |
| PasswordTip | パスワードのチェック結果をツールチップで通知します。ツールチップの表示時間や各チェック結果に対するツールチップの表示内容を指定します。 |
パスワード強度の判定には以下の条件を満たす場合にそれぞれ加算され、点数が1・2点の場合は弱、3・4点の場合は中、5・6点の場合は強と判定します。
- 入力したパスワードが小文字を含む場合
- 入力したパスワードが大文字を含む場合
- 入力したパスワードが数値を含む場合
- 入力したパスワードが記号を含む場合
- 入力したパスワードの入力長がMinLengthを超える場合
- 入力したパスワードの入力長がMaxLength/MinLengthで設定した値の中央値を超える場合
LowerCaseVerify、UpperCaseVerify、NumberVerify、SymbolVerifyを有効にした場合で対応する文字の入力がない場合、もしくはLengthVerifyを有効にした場合でMinLength/MaxLengthの範囲外の入力は無効と判定します。
コントロールに文字列を入力するとTextChanging イベントが、TextChanged イベントの前（入力された文字列がText プロパティに渡される前）に発生します。このイベント内で入力文字列をチェックすれば、Text プロパティの値に影響を与えることなく、入力を制御できます。