MaskedTextProvider クラス

定義

MaskedTextBox コントロールなど、マスクをサポートする多数のコントロールで使用できるマスク解析サービスを表します。

public ref class MaskedTextProvider : ICloneable
public class MaskedTextProvider : ICloneable
type MaskedTextProvider = class
    interface ICloneable
Public Class MaskedTextProvider
Implements ICloneable
継承
MaskedTextProvider
実装

注釈

MaskedTextBoxコントロールには、リテラル文字と書式設定要素で構成されるマスクが含まれており、すべてのユーザー入力をテストします。 特定のマスク解析エンジンMaskedTextBoxを に永続的に関連付ける代わりに、Windows フォームは、 クラスでMaskedTextProvider表される別のサービスとして提供します。これは、 プロパティのドキュメントで説明されているマスク言語の構文をMask定義します。

クラスのメンバーの MaskedTextBox 多くは、その実装を、関連付けられている MaskedTextProviderの同様の名前付きメンバーに参照します。 たとえば、 クラスの プロパティはMaskedTextBox.PromptCharMaskedTextBox クラスの へのすべてのアクセスをPromptCharMaskedTextProvider参照します。

によってMaskedTextProvider使用されるマスク解析エンジンは、Visual Basic バージョン 6 に含まれる Masked Edit コントロールMicrosoftモデル化されます。 そのマスク言語については、 プロパティのドキュメント Mask で説明されています。

クラスには、次の 3 つの異なる文字列が MaskedTextProvider 関係します。

文字列名 [説明]
入力文字または文字列 マスクが適用される入力として使用される文字を表します。 実際には、入力文字列は、、ReplaceInsertAt、、 Removeを含むAdd複数の入力操作で構成される場合があります。 したがって、入力文字列に直接アクセスすることはできません。 ただし、入力文字列処理の側面は、 プロパティ、および AsciiOnlyResetOnPromptResetOnSpace プロパティをAllowPromptAsInput使用できます。
マスク 入力文字列を書式設定された文字列に変換するために使用される入力書式マスクを表します。 この文字列は で MaskedTextProvider 設定され、主に プロパティを Mask 使用してアクセスされます。 マスクの特性は、 プロパティなどの他のLengthPasswordCharPromptCharメンバーでも使用できます。
書式設定された文字列 完全なマスクが入力文字列に適用されるときに発生する文字列を表します。 書式設定された文字列は、など、Item[]FindEditPositionFromLengthLastAssignedPositionMaskFullMaskCompletedクラスの多くのメンバーで照会できます。 書式設定された文字列の完全な値は、 メソッドと ToString メソッドからToDisplayString使用できます。

Note

入力文字列は、 の場合と同様に、直接のユーザー入力を MaskedTextBox表す場合もあれば、ユーザーの入出力操作に直接関連付けられていない他のプロセスによって生成される場合もあります。

コンストラクター

MaskedTextProvider(String)

指定したマスクを使用して、MaskedTextProvider クラスの新しいインスタンスを初期化します。

MaskedTextProvider(String, Boolean)

指定したマスクと ASCII 制限値を使用して、MaskedTextProvider クラスの新しいインスタンスを初期化します。

MaskedTextProvider(String, Char, Boolean)

指定したマスク、パスワード文字、プロンプト使用値を使用して、MaskedTextProvider クラスの新しいインスタンスを初期化します。

MaskedTextProvider(String, CultureInfo)

指定したマスクとカルチャを使用して、MaskedTextProvider クラスの新しいインスタンスを初期化します。

MaskedTextProvider(String, CultureInfo, Boolean)

指定したマスク、カルチャ、および ASCII 制限値を使用して、MaskedTextProvider クラスの新しいインスタンスを初期化します。

MaskedTextProvider(String, CultureInfo, Boolean, Char, Char, Boolean)

指定したマスク、カルチャ、プロンプト使用値、プロンプト文字、パスワード文字、および ASCII 制限値を使用して、MaskedTextProvider クラスの新しいインスタンスを初期化します。

MaskedTextProvider(String, CultureInfo, Char, Boolean)

指定したマスク、カルチャ、パスワード文字、およびプロンプト使用値を使用して、MaskedTextProvider クラスの新しいインスタンスを初期化します。

プロパティ

AllowPromptAsInput

プロンプト文字を有効な入力文字として扱う必要があるかどうかを示す値を取得します。

AsciiOnly

マスクで ASCII 文字セット以外の文字を受け入れるかどうかを示す値を取得します。

AssignedEditPositionCount

入力値が既に正常に割り当てられている、編集可能な文字位置の数を取得します。

AvailableEditPositionCount

入力値がまだ割り当てられていない、入力マスク内の編集可能な文字位置の数を取得します。

Culture

入力マスク内のローカライズ可能な区切り記号とプレースホルダーの値を決定するカルチャを取得します。

DefaultPasswordChar

ユーザー入力を隠すために使用する既定のパスワード文字を取得します。

EditPositionCount

書式設定された文字列内の編集可能な位置の数を取得します。

EditPositions

書式設定された文字列内の編集可能な位置に対して新しく作成された列挙子を取得します。

IncludeLiterals

入力マスク内のリテラル文字を、書式設定された文字列に含める必要があるかどうかを示す値を取得または設定します。

IncludePrompt

書式設定された文字列を表示するときに、PromptChar を使用してユーザー入力がないことを表すかどうかを示す値を取得または設定します。

InvalidIndex

無効なインデックスの範囲の上限を取得します。

IsPassword

書式設定された文字列に、パスワードによる保護を適用する必要があるかどうかを決定する値を取得または設定します。

Item[Int32]

書式設定された文字列内の指定した位置にある要素を取得します。

LastAssignedPosition

マスクに割り当てられている右端の入力文字のマスク内のインデックスを取得します。

Length

マスク修飾子文字を除いたマスクの長さを取得します。

Mask

入力マスクを取得します。

MaskCompleted

すべての必須入力が、書式設定された文字列に入力されているかどうかを示す値を取得します。

MaskFull

すべての必須入力と省略可能な入力が、書式設定された文字列に入力されているかどうかを示す値を取得します。

PasswordChar

実際の入力文字を置き換える文字を取得または設定します。

PromptChar

使用できるすべての編集位置に対してユーザー入力がないことを表す際に使用する文字を取得または設定します。

ResetOnPrompt

プロンプト文字と一致する入力文字を処理する方法を決定する値を取得または設定します。

ResetOnSpace

空白の入力文字の処理方法を決定する値を取得または設定します。

SkipLiterals

マスク内のリテラル文字の位置を、同じ値で上書きできるかどうかを示す値を取得または設定します。

メソッド

Add(Char)

書式設定された文字列の末尾に指定した入力文字を追加します。

Add(Char, Int32, MaskedTextResultHint)

書式設定された文字列の末尾に指定した入力文字を追加し、位置と説明の情報を出力します。

Add(String)

書式設定された文字列の末尾に指定した入力文字列内の文字を追加します。

Add(String, Int32, MaskedTextResultHint)

書式設定された文字列の末尾に指定した入力文字列内の文字を追加し、位置と説明の情報を出力します。

Clear()

書式設定された文字列から、編集可能なすべての入力文字を消去し、プロンプト文字に置き換えます。

Clear(MaskedTextResultHint)

書式設定された文字列から、編集可能なすべての入力文字を消去し、プロンプト文字に置き換えた後、説明の情報を出力します。

Clone()

現在の MaskedTextProvider のコピーを作成します。

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
FindAssignedEditPositionFrom(Int32, Boolean)

指定した検索方向で、指定した位置より後にある、入力が割り当てられた最初の編集可能な位置を返します。

FindAssignedEditPositionInRange(Int32, Int32, Boolean)

指定した検索方向で、指定した 2 つの位置の間にある、入力が割り当てられた最初の編集可能な位置を返します。

FindEditPositionFrom(Int32, Boolean)

指定した検索方向で、指定した位置より後にある最初の編集可能な位置を返します。

FindEditPositionInRange(Int32, Int32, Boolean)

指定した検索方向で、指定した 2 つの位置の間にある最初の編集可能な位置を返します。

FindNonEditPositionFrom(Int32, Boolean)

指定した検索方向で、指定した位置より後にある最初の編集不可能な位置を返します。

FindNonEditPositionInRange(Int32, Int32, Boolean)

指定した検索方向で、指定した 2 つの位置の間にある最初の編集不可能な位置を返します。

FindUnassignedEditPositionFrom(Int32, Boolean)

指定した検索方向で、指定した位置より後にある、入力が割り当てられていない最初の編集可能な位置を返します。

FindUnassignedEditPositionInRange(Int32, Int32, Boolean)

指定した検索方向で、指定した 2 つの位置の間にある、入力が割り当てられていない最初の編集可能な位置を返します。

GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetOperationResultFromHint(MaskedTextResultHint)

指定した MaskedTextResultHint が、成功または失敗のどちらを示しているかを判断します。

GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
InsertAt(Char, Int32)

書式設定された文字列内の指定した位置に指定した文字を挿入します。

InsertAt(Char, Int32, Int32, MaskedTextResultHint)

書式設定された文字列内の指定した位置に指定した文字を挿入し、最後の挿入位置と操作のステータスを返します。

InsertAt(String, Int32)

書式設定された文字列内の指定した位置に指定した文字列を挿入します。

InsertAt(String, Int32, Int32, MaskedTextResultHint)

書式設定された文字列内の指定した位置に指定した文字列を挿入し、最後の挿入位置と操作のステータスを返します。

IsAvailablePosition(Int32)

指定した位置を入力の割り当てに使用できるかどうかを判断します。

IsEditPosition(Int32)

指定した位置が編集可能かどうかを判断します。

IsValidInputChar(Char)

指定した文字が有効な入力文字かどうかを判断します。

IsValidMaskChar(Char)

指定した文字が有効なマスク文字かどうかを判断します。

IsValidPasswordChar(Char)

指定した文字が有効なパスワード文字かどうかを判断します。

MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
Remove()

書式設定された文字列から、割り当てられた最後の文字を削除します。

Remove(Int32, MaskedTextResultHint)

書式設定された文字列から、割り当てられた最後の文字を削除し、削除位置と説明の情報を出力します。

RemoveAt(Int32)

書式設定された文字列から、指定した位置にある割り当てられた文字を削除します。

RemoveAt(Int32, Int32)

書式設定された文字列から、指定した 2 つの位置の間にある割り当てられた文字を削除します。

RemoveAt(Int32, Int32, Int32, MaskedTextResultHint)

書式設定された文字列から、指定した 2 つの位置の間にある割り当てられた文字を削除し、削除位置と説明の情報を出力します。

Replace(Char, Int32)

指定した位置以降にある単一の文字を指定した文字値に置き換えます。

Replace(Char, Int32, Int32, Int32, MaskedTextResultHint)

指定した開始位置と終了位置の間にある単一の文字を指定した文字値に置き換え、削除位置と説明の情報を出力します。

Replace(Char, Int32, Int32, MaskedTextResultHint)

指定した位置以降にある単一の文字を指定した文字値に置き換え、削除位置と説明の情報を出力します。

Replace(String, Int32)

指定した位置から始まる編集可能な文字の範囲を、指定した文字列に置き換えます。

Replace(String, Int32, Int32, Int32, MaskedTextResultHint)

指定した開始位置と終了位置の間にある編集可能な文字の範囲を指定した文字列に置き換え、削除位置と説明の情報を出力します。

Replace(String, Int32, Int32, MaskedTextResultHint)

指定した位置から始まる編集可能な文字の範囲を指定した文字列に置き換え、削除位置と説明の情報を出力します。

Set(String)

書式設定された文字列に指定した入力文字列を設定します。

Set(String, Int32, MaskedTextResultHint)

書式設定された文字列に指定した入力文字列を設定し、削除位置と説明の情報を出力します。

ToDisplayString()

表示できる形式で書式設定された文字列を返します。

ToString()

割り当てられたすべての文字値を含む、書式設定された文字列を返します。

ToString(Boolean)

書式設定された文字列を返します。パスワード文字が含まれる場合もあります。

ToString(Boolean, Boolean)

書式設定された文字列を返します。プロンプト文字やリテラル文字が含まれる場合もあります。

ToString(Boolean, Boolean, Boolean, Int32, Int32)

書式設定された文字列の部分文字列を返します。プロンプト文字、リテラル文字、およびパスワード文字が含まれる場合もあります。

ToString(Boolean, Boolean, Int32, Int32)

書式設定された文字列の部分文字列を返します。プロンプト文字やリテラル文字が含まれる場合もあります。

ToString(Boolean, Int32, Int32)

書式設定された文字列の部分文字列を返します。パスワード文字が含まれる場合もあります。

ToString(Int32, Int32)

書式設定された文字列の部分文字列を返します。

VerifyChar(Char, Int32, MaskedTextResultHint)

指定した文字を指定した位置に正常に設定できるかどうかをテストします。

VerifyEscapeChar(Char, Int32)

指定した文字が指定した位置でエスケープされるかどうかをテストします。

VerifyString(String)

指定した文字列を正常に設定できるかどうかをテストします。

VerifyString(String, Int32, MaskedTextResultHint)

指定した文字列を正常に設定できるかどうかをテストし、位置と説明の情報を出力します。

適用対象

こちらもご覧ください