MaskedTextBox.Mask プロパティとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

MaskedTextBox.Mask プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

実行時に使用する入力マスクを取得または設定します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

<LocalizableAttribute(True)> _
Public Property Mask As
 String

Visual Basic (使用法)

Dim instance As MaskedTextBox
Dim value As String

value = instance.Mask

instance.Mask = value

[LocalizableAttribute(true)] 
public string Mask { get;
 set; }

C++

[LocalizableAttribute(true)] 
public:
property String^ Mask {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_Mask ()

/** @property */
public void set_Mask (String value)

JScript

public function get Mask
 () : String

public function set Mask
 (value : String)

プロパティ値
現在のマスクを表す String。既定値は、任意の入力を許可する空の文字列です。

例外

例外の種類	条件
ArgumentException	Mask プロパティに指定された文字列が有効なマスクではありません。無効なマスクには、印字不可能な文字を格納しているマスクが含まれます。

解説

Mask は、MaskedTextBox クラスの既定のプロパティです。

Mask は、次の表に示した、1 つ以上のマスク要素で構成される文字列である必要があります。MaskedTextBox で使用されるマスク言語は、関連する MaskedTextProvider で定義されます。標準プロバイダは、Visual Basic 6.0 のマスクエディットコントロールで使用されるマスク言語に基づいてマスク言語を指定し、そのプラットフォームから移行するユーザーにとって既知のプロバイダである必要があります。

マスク要素	説明
0	数字 (省略不可)。この要素は、0 ～ 9 の 1 桁の数字を受け入れます。
9	数字または空白 (省略可)。
#	数字または空白 (省略可)。マスク内のこの位置を空白にすると、Text プロパティで空白として描画されます。正符号 (+) およびマイナス記号 (-) を使用できます。
L	文字 (省略不可)。入力を ASCII 文字 a ～ z および A ～ Z に制限します。このマスク要素は、正規表現の [a-zA-Z] と等価です。
?	文字 (省略可)。入力を ASCII 文字 a ～ z および A ～ Z に制限します。このマスク要素は、正規表現の [a-zA-Z]? と等価です。
&	文字 (省略不可)。AsciiOnly プロパティが true に設定されている場合、この要素は "L" 要素と同じように動作します。
C	文字 (省略可)。制御文字以外の文字を入力できます。AsciiOnly プロパティが true に設定されている場合、この要素は "?" 要素と同じように動作します。
A	英数字 (省略可)。AsciiOnly プロパティが true に設定されている場合、受け入れられる文字は、ASCII 文字 a ～ z および A ～ Z だけです。
a	英数字 (省略可)。AsciiOnly プロパティが true に設定されている場合、受け入れられる文字は、ASCII 文字 a ～ z および A ～ Z だけです。
.	小数点のプレースホルダ。使用される実際の表示文字は、コントロールの FormatProvider プロパティで決定される書式プロバイダに適した小数点記号になります。
,	桁区切りのプレースホルダ。使用される実際の表示文字は、コントロールの FormatProvider プロパティで決定される書式プロバイダに適した桁区切りのプレースホルダになります。
:	時刻の区切り記号。使用される実際の表示文字は、コントロールの FormatProvider プロパティで決定される書式プロバイダに適した時刻の記号になります。
/	日付の区切り記号。使用される実際の表示文字は、コントロールの FormatProvider プロパティで決定される書式プロバイダに適した日付の記号になります。
$	通貨記号。表示される実際の文字は、コントロールの FormatProvider プロパティで決定される書式プロバイダに適した通貨記号になります。
<	下にシフトします。後続のすべての文字を小文字に変換します。
>	上にシフトします。後続のすべての文字を大文字に変換します。
\|	前に行われた上または下へのシフトを無効にします。
\	エスケープ。マスク文字をエスケープして、リテラルに変換します。"\\" は、円記号のエスケープシーケンスです。
その他のすべての文字	リテラル。マスク要素以外の文字はすべて、MaskedTextBox 内にそのまま表示されます。リテラルは実行時のマスクの静的な位置を常に占有するため、ユーザーが移動または削除することはできません。

MaskedTextBox が、前のマスクでフィルタ処理されたユーザー入力を既に含んでいる場合にマスクを変更すると、MaskedTextBox はその入力を新しいマスク定義に移行しようとします。移行に失敗すると、既存の入力が消去されます。長さ 0 の文字列をマスクとして割り当てると、コントロール内の既存のデータが保持されます。長さ 0 のマスクで使用する場合、MaskedTextBox は単一行の TextBox コントロールと同じように動作します。

小数点 (.)、桁区切り (,)、時刻 (:)、日付 (/)、および通貨 ($) 記号は、既定ではアプリケーションのカルチャで定義された記号を表示するように設定されます。FormatProvider プロパティを使用すると、別のカルチャの記号を強制的に表示できます。

実行時のマスクへの文字挿入は、InsertKeyMode プロパティによって制御されます。ユーザーは、左右の方向キーまたはマウスカーソルを使用してマスク内を移動できます。また、空白を入力すると、マスク内のオプションの位置をスキップできます。

重要 :
MaskedTextBox は、サロゲートおよび垂直方向の組み合わせ文字を除くすべての Unicode 文字をサポートします。

マスクの例を次の表に示します。

マスク	動作
`00/00/0000`	国際対応の日付形式の日付 (日、月を表す数値、年)。"/" 文字は論理的な日付区切り記号で、アプリケーションの現在のカルチャに適した日付区切り記号としてユーザーに表示されます。
`00->L<LL-0000`	米国形式の日付 (日、月の省略形、および年)。3 文字の月の省略形は、最初の 1 文字が大文字、後の 2 文字が小文字で表示されます。
`(999)-000-0000`	米国の電話番号。市外局番はオプションです。ユーザーがオプションの文字を入力しない場合は、空白を入力するか、最初の 0 で表されるマスクの位置に直接マウスポインタを置くことができます。
`$999,999.00`	0 ～ 999999 の範囲の通貨値。通貨、桁区切り、および小数点文字は、実行時にカルチャ固有の同等の文字に置換されます。