未入力時の表示

マスクコントロールでは未入力のときや入力が完了していないとき、様々な補助機能を提供しています。この章ではそれらの機能について解説します。

未入力時に表示する代替テキスト

Watermarkプロパティを使用すれば、コントロールが未入力のときに代わりに表示するテキスト（ウォーターマーク）を設定することができます。 Watermarkプロパティは、WatermarkBaseオブジェクトを参照します。
コントロールにフォーカスがあるときのテキストを設定するには、WatermarkBase.Nullプロパティを使用します。コントロールにフォーカスがないときのテキストを設定するには、WatermarkBase.DisplayNullプロパティを使用します。

これらのプロパティはWatermarkクラスを参照し、次の2つのプロパティを設定することができます。

ForeColor（テキストの前景色）
Text（表示するテキスト）

（図）代替テキストを表示したマスクコントロール

次のサンプルコードは、上図のような代替テキストを表示する方法です。

Visual Basic
C#

' フォーカスがないときの代替テキスト
GcMask1.Watermark.DisplayNull.Text = "電話番号"
GcMask1.Watermark.DisplayNull.ForeColor = System.Drawing.Color.PowderBlue

' フォーカスがあるときの代替テキスト
GcMask1.Watermark.Null.Text = "市外局番から入力してください"
GcMask1.Watermark.Null.ForeColor = System.Drawing.Color.Gray

// フォーカスがないときの代替テキスト
GcMask1.Watermark.DisplayNull.Text = "電話番号";
GcMask1.Watermark.DisplayNull.ForeColor = System.Drawing.Color.PowderBlue;

// フォーカスがあるときの代替テキスト
GcMask1.Watermark.Null.Text = "市外局番から入力してください";
GcMask1.Watermark.Null.ForeColor = System.Drawing.Color.Gray;

プロンプト文字

フィールドに何も入力されていないときに表示するプロンプト文字は、PromptCharプロパティを使用して設定します。プロンプト文字はMaskFormat.Patternプロパティに定義された入力マスクの位置にプレースホルダとして表示され、ユーザに入力を促します。なお、PromptCharプロパティには、半角または全角の文字を設定できますが、文字列は設定できません。

（図）プロンプト文字（"_"）

代替テキストを設定している場合、コントロールに文字が入力されていないときには代替テキストの設定が優先されます。未入力時に、MaskFormat.Patternプロパティで設定したリテラル文字列を含む書式とプロンプト文字を表示するには、次のサンプルコードのように、代替テキストを空の文字列に設定します。

Visual Basic
C#

GcMask1.Watermark.DisplayNull.Text = String.Empty
GcMask1.Watermark.Null.Text = String.Empty
GcMask1.Format.Pattern = "TEL \D{2,4}-\D{2,4}-\D{4}"
GcMask1.PromptChar = "_"

GcMask1.Watermark.DisplayNull.Text = string.Empty;
GcMask1.Watermark.Null.Text = string.Empty;
GcMask1.Format.Pattern = "TEL \\D{2,4}-\\D{2,4}-\\D{4}";
GcMask1.PromptChar = '_';

参照