入力の制御

テキストコントロールが提供する入力を制御する機能について解説します。

書式の設定

テキストコントロールは、Formatプロパティにより書式を設定することで入力可能な文字種を制限することができます。また、AutoConvertプロパティを使用して指定の書式に自動的に変換することも可能です。

テキストコントロールに設定可能な文字種等の詳細については、「書式の設定」で解説します。

IMEモード設定

ImeModeプロパティを使用して、コントロールがフォーカスを取得したときのIMEの状態を設定することができます。
ImeModeプロパティに設定可能な値は次のとおりで、既定値はImeMode.Autoです。

ImeModeの値	説明
Auto	指定しません。
Active	日本語入力モードになります。
InActive	半角英数文字入力モードになります。
Disabled	IMEが無効になります。手動でIMEを有効にすることもできません。

最大文字数の指定

LengthAsByteプロパティを使えば、MaxLengthプロパティでコントロールへの入力可能文字数を設定する際に、バイト単位と文字単位のどちらを使うかを指定できます。LengthAsByteプロパティをTrueに設定すると、MaxLengthプロパティはバイト単位で処理され、Falseにすると文字単位で処理されます。

ふりがなの取得

IMEを使用して文字を入力したときに、その文字のふりがなを取得し、他のコントロールに表示することができます。ふりがなを表示するコントロールは、ReadingImeStringOutputオブジェクトのTargetControlプロパティで設定することができます。また、ReadingImeStringOutputオブジェクトのOutputModeプロパティで、ふりがなの出力テキストを既にコントロールに表示されているテキストの末尾に追加するか、既存テキスト上書きするかを設定することができます。
KanaModeプロパティは出力されるふりがなの文字種を指定できます。

ふりがなの取得に関しては、制限事項があります。詳細については「制限事項と注意点」を参照してください。

次のサンプルコードでは、GcTextBox2に入力された文字のふりがなを、GcTextBox1に半角カナで表示します。

Visual Basic
C#

Imports GrapeCity.Web.Input.IMEdit

' ふりがなの出力方法と出力先を指定します。
GcTextBox2.ReadingImeStringOutput.TargetControl = "GcTextBox1"
GcTextBox2.ReadingImeStringOutput.OutputMode = OutputMode.Append
' 出力先のコントロールの書式を半角カナに設定します。
GcTextBox2.ReadingImeStringOutput.KanaMode = KanaMode.KatakanaHalf

using GrapeCity.Web.Input.IMEdit;

// ふりがなの出力方法と出力先を指定します。
GcTextBox2.ReadingImeStringOutput.TargetControl = "GcTextBox1";
GcTextBox2.ReadingImeStringOutput.OutputMode = OutputMode.Append;
// 出力先のコントロールの書式を半角カナに設定します。
GcTextBox2.ReadingImeStringOutput.KanaMode = KanaMode.KatakanaHalf;

改行コードの取り扱い

AcceptsCrLfプロパティを使用してクリップボードへ改行を含む文字列をコピー、または貼り付けた場合の改行コードの扱いを設定できます。AcceptsCrLfプロパティは、以下の3つの動作から選択します。既定値はCrLfMode.NoControlです。

AcceptsCrLfの値	説明
NoControl	改行コードはそのままでコピー、貼り付けを行います。
Filter	コピー、切り取り、または貼り付け文字列内にあるすべての改行コードを削除します。
Cut	コピー、切り取り、および貼り付け文字列内にある最初の改行コード以降の文字列を切り取ります。

なお、複数行モードの場合はAcceptsCrLfプロパティの設定は無効になります。

履歴リストの表示

ShowHistoryプロパティをTrueにすると、履歴リストを表示することができます。テキストコントロールではFormatプロパティで指定した文字種以外の入力を許可しないように、ブラウザのオートコンプリート機能はサポートされません。履歴リストには、入力可能な文字種が表示されます。

MaxHistoryCountプロパティを使って履歴リストの表示できる最大項目数を指定することができます。