MaskedTextProvider Class

Definición

Representa un servicio de análisis de máscaras que cualquier control compatible con el uso de máscaras puede utilizar como, por ejemplo, MaskedTextBox. Represents a mask-parsing service that can be used by any number of controls that support masking, such as the MaskedTextBox control.

public class MaskedTextProvider : ICloneable
Herencia
MaskedTextProvider
Implementaciones

Comentarios

El MaskedTextBox control contiene una máscara, formada por caracteres literales y elementos de formato, que prueba todas las entradas de usuario con.The MaskedTextBox control contains a mask, composed of literal characters and formatting elements, that it tests all user input against. En lugar de asociar permanentemente un motor de análisis de máscaras específico con MaskedTextBox, Windows Forms que lo proporciona como un servicio independiente, representado por la MaskedTextProvider (clase), que define la sintaxis del lenguaje de enmascaramiento se describe en la documentación de el Mask propiedad.Instead of permanently associating a specific mask-parsing engine with MaskedTextBox, Windows Forms provides it as a separate service, represented by the MaskedTextProvider class, which defines the syntax of the masking language discussed in the documentation for the Mask property.

Muchos de los miembros de la MaskedTextBox clase hacen referencia a su implementación a los miembros con el mismo nombre de asociado MaskedTextProvider.Many of the members of the MaskedTextBox class refer their implementation to similarly named members of the associated MaskedTextProvider. Por ejemplo, el MaskedTextBox.PromptChar propiedad de la MaskedTextBox clase hace referencia a todo el acceso a la PromptChar de la MaskedTextProvider clase.For example, the MaskedTextBox.PromptChar property of the MaskedTextBox class refers all access to the PromptChar of the MaskedTextProvider class.

Utilizado por el motor de análisis de máscaras MaskedTextProvider se modela después del control de edición con máscara incluido en Microsoft Visual Basic versión 6.The mask-parsing engine used by MaskedTextProvider is modeled after the Masked Edit control included in Microsoft Visual Basic version 6. Su lenguaje de enmascaramiento se describe en la documentación para el Mask propiedad.Its masking language is described in the documentation for the Mask property.

Intervienen tres cadenas distintas con la MaskedTextProvider clase.The following three distinct strings are involved with the MaskedTextProvider class.

Nombre de la cadenaString name DescripciónDescription
Carácter de entrada o de cadenaInput character or string Representa los caracteres utilizados como entrada que se aplica la máscara.Represents the characters used as input that the mask is applied against. En realidad, la cadena de entrada puede estar compuesta de varias operaciones de entrada, incluidos Add, Replace, InsertAt, y Remove.In actuality, the input string may be composed of multiple input operations, including Add, Replace, InsertAt, and Remove. Por lo tanto, la cadena de entrada no son accesibles directamente.Therefore, the input string cannot be accessed directly. Sin embargo, los aspectos de la administración de la cadena de entrada están disponibles aunque el AllowPromptAsInput y AsciiOnly, ResetOnPrompt, y ResetOnSpace propiedades.However, aspects of the input string handling are available though the AllowPromptAsInput and AsciiOnly, ResetOnPrompt, and ResetOnSpace properties.
MáscaraMask Representa el formato de máscara que se utiliza para transformar la cadena de entrada en la cadena con formato de entrada.Represents the input formatting mask used to transform the input string into the formatted string. Esta cadena se establece el MaskedTextProvider y obtener acceso principalmente aunque el Mask propiedad.This string is set in the MaskedTextProvider and accessed primarily though the Mask property. Las características de la máscara también están disponibles a través de otros miembros, como el Length, PasswordChar, y PromptChar propiedades.Characteristics of the mask are also available through other members, such as the Length, PasswordChar, and PromptChar properties.
Cadena con formatoFormatted string Representa la cadena que se produce cuando se aplica la máscara completa a la cadena de entrada.Represents the string that results when the full mask is applied to the input string. La cadena con formato se puede consultar con muchos miembros de la clase, incluidos Item[Int32], Length, LastAssignedPosition, MaskFull, MaskCompleted, FindEditPositionFrom, y así sucesivamente.The formatted string can be queried with many members of the class, including Item[Int32], Length, LastAssignedPosition, MaskFull, MaskCompleted, FindEditPositionFrom, and so on. El valor completo de la cadena con formato está disponible desde el ToDisplayString y ToString métodos.The full value of the formatted string is available from the ToDisplayString and ToString methods.

Nota

La cadena de entrada puede representar la entrada directa del usuario, como en el caso de los MaskedTextBox, o puede generarse por otros procesos no directamente asociados a las operaciones de entrada/salida de usuario.The input string may represent direct user input, as in the case of the MaskedTextBox, or may be generated by other processes not directly associated with user input/output operations.

Constructores

MaskedTextProvider(String)

Inicializa una nueva instancia de la clase MaskedTextProvider con la máscara especificada. Initializes a new instance of the MaskedTextProvider class using the specified mask.

MaskedTextProvider(String, Boolean)

Inicializa una nueva instancia de la clase MaskedTextProvider con la máscara y el valor de restricción ASCII especificados. Initializes a new instance of the MaskedTextProvider class using the specified mask and ASCII restriction value.

MaskedTextProvider(String, Char, Boolean)

Inicializa una nueva instancia de la clase MaskedTextProvider con la máscara, el carácter de contraseña y el valor de uso del carácter de petición de datos que se hayan especificado. Initializes a new instance of the MaskedTextProvider class using the specified mask, password character, and prompt usage value.

MaskedTextProvider(String, CultureInfo)

Inicializa una nueva instancia de la clase MaskedTextProvider con la máscara y referencia cultural especificadas. Initializes a new instance of the MaskedTextProvider class using the specified mask and culture.

MaskedTextProvider(String, CultureInfo, Boolean)

Inicializa una nueva instancia de la clase MaskedTextProvider con la máscara, la referencia cultural y el valor de restricción ASCII especificados. Initializes a new instance of the MaskedTextProvider class using the specified mask, culture, and ASCII restriction value.

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

Inicializa una nueva instancia de la clase MaskedTextProvider con la máscara, la referencia cultural, el valor de uso del carácter de petición de datos, el carácter de petición de datos, el carácter de contraseña y valor de restricción ASCII especificados. Initializes a new instance of the MaskedTextProvider class using the specified mask, culture, prompt usage value, prompt character, password character, and ASCII restriction value.

MaskedTextProvider(String, CultureInfo, Char, Boolean)

Inicializa una nueva instancia de la clase MaskedTextProvider con la máscara, la referencia cultural, el carácter de contraseña y el valor de uso del carácter de petición de datos que se hayan especificado. Initializes a new instance of the MaskedTextProvider class using the specified mask, culture, password character, and prompt usage value.

Propiedades

AllowPromptAsInput

Obtiene un valor que indica si el carácter de petición de datos debe considerarse como un carácter de entrada válido o no. Gets a value indicating whether the prompt character should be treated as a valid input character or not.

AsciiOnly

Obtiene un valor que indica si la máscara acepta caracteres que no pertenecen al juego de caracteres ASCII. Gets a value indicating whether the mask accepts characters outside of the ASCII character set.

AssignedEditPositionCount

Obtiene el número de posiciones de caracteres modificables a las que ya se les ha asignado correctamente un valor de entrada. Gets the number of editable character positions that have already been successfully assigned an input value.

AvailableEditPositionCount

Obtiene el número de posiciones de caracteres modificables de la máscara de entrada a las que aún no se les ha asignado un valor de entrada. Gets the number of editable character positions in the input mask that have not yet been assigned an input value.

Culture

Obtiene la referencia cultural que determina el valor de los separadores y marcadores de posición localizables de la máscara de entrada. Gets the culture that determines the value of the localizable separators and placeholders in the input mask.

DefaultPasswordChar

Obtiene el carácter de contraseña predeterminado que se utiliza para ocultar los datos proporcionados por el usuario. Gets the default password character used obscure user input.

EditPositionCount

Obtiene el número de posiciones modificables de la cadena con formato. Gets the number of editable positions in the formatted string.

EditPositions

Obtiene un enumerador recién creado para las posiciones modificables de la cadena con formato. Gets a newly created enumerator for the editable positions in the formatted string.

IncludeLiterals

Obtiene o establece un valor que indica si los caracteres literales de la máscara de entrada deben incluirse en la cadena con formato. Gets or sets a value that indicates whether literal characters in the input mask should be included in the formatted string.

IncludePrompt

Obtiene o establece un valor que indica si la propiedad PromptChar se utiliza para representar que el usuario no ha especificado ningún dato cuando se muestra la cadena con formato. Gets or sets a value indicating whether PromptChar is used to represent the absence of user input when displaying the formatted string.

InvalidIndex

Obtiene el límite superior del intervalo de índices que no son válidos. Gets the upper bound of the range of invalid indexes.

IsPassword

Obtiene o establece un valor que determina si se debe aplicar protección con contraseña a la cadena con formato. Gets or sets a value that determines whether password protection should be applied to the formatted string.

Item[Int32]

Obtiene el elemento situado en la posición especificada de la cadena con formato. Gets the element at the specified position in the formatted string.

LastAssignedPosition

Obtiene el índice de la máscara correspondiente al carácter de entrada situado más a la derecha que se haya asignado a la máscara. Gets the index in the mask of the rightmost input character that has been assigned to the mask.

Length

Obtiene la longitud de la máscara, sin ningún carácter modificador de máscara. Gets the length of the mask, absent any mask modifier characters.

Mask

Obtiene la máscara de entrada. Gets the input mask.

MaskCompleted

Obtiene un valor que indica si se han especificado todas las entradas obligatorias en la cadena con formato. Gets a value indicating whether all required inputs have been entered into the formatted string.

MaskFull

Obtiene un valor que indica si se han especificado todas las entradas obligatorias y opcionales en la cadena con formato. Gets a value indicating whether all required and optional inputs have been entered into the formatted string.

PasswordChar

Obtiene o establece el carácter que se va a sustituir por los caracteres de entrada reales. Gets or sets the character to be substituted for the actual input characters.

PromptChar

Obtiene o establece el carácter que se utiliza para representar que el usuario no ha especificado ningún dato para todas las posiciones de edición disponibles. Gets or sets the character used to represent the absence of user input for all available edit positions.

ResetOnPrompt

Obtiene o establece un valor que determina la forma en que debe controlarse un carácter de entrada que coincida con el de petición de datos. Gets or sets a value that determines how an input character that matches the prompt character should be handled.

ResetOnSpace

Obtiene o establece un valor que determina la forma en que debe controlarse un carácter de entrada de espacio. Gets or sets a value that determines how a space input character should be handled.

SkipLiterals

Obtiene o establece un valor que indica si las posiciones de caracteres literales de la máscara se pueden sobrescribir con sus mismos valores. Gets or sets a value indicating whether literal character positions in the mask can be overwritten by their same values.

Métodos

Add(Char)

Agrega el carácter de entrada especificado al final de la cadena con formato. Adds the specified input character to the end of the formatted string.

Add(Char, Int32, MaskedTextResultHint)

Agrega el carácter de entrada especificado al final de la cadena con formato y, a continuación, genera información sobre la posición e información descriptiva. Adds the specified input character to the end of the formatted string, and then outputs position and descriptive information.

Add(String)

Agrega los caracteres de la cadena de entrada especificada al final de la cadena con formato. Adds the characters in the specified input string to the end of the formatted string.

Add(String, Int32, MaskedTextResultHint)

Agrega los caracteres de la cadena de entrada especificada al final de la cadena con formato y, a continuación, genera información sobre la posición e información descriptiva. Adds the characters in the specified input string to the end of the formatted string, and then outputs position and descriptive information.

Clear()

Borra todos los caracteres de entrada modificables de la cadena con formato, reemplazándolos por caracteres de petición de datos. Clears all the editable input characters from the formatted string, replacing them with prompt characters.

Clear(MaskedTextResultHint)

Borra todos los caracteres de entrada modificables de la cadena con formato, reemplazándolos por caracteres de petición de datos y, a continuación, genera información descriptiva. Clears all the editable input characters from the formatted string, replacing them with prompt characters, and then outputs descriptive information.

Clone()

Crea una copia del objeto MaskedTextProvider actual. Creates a copy of the current MaskedTextProvider.

Equals(Object)

Determina si el objeto especificado es igual al objeto actual. Determines whether the specified object is equal to the current object.

(Inherited from Object)
FindAssignedEditPositionFrom(Int32, Boolean)

Devuelve la posición de la primera posición modificable asignada que se encuentre después de la posición especificada utilizando la dirección de búsqueda indicada. Returns the position of the first assigned editable position after the specified position using the specified search direction.

FindAssignedEditPositionInRange(Int32, Int32, Boolean)

Devuelve la posición de la primera posición modificable asignada que se encuentre entre las posiciones especificadas utilizando la dirección de búsqueda indicada. Returns the position of the first assigned editable position between the specified positions using the specified search direction.

FindEditPositionFrom(Int32, Boolean)

Devuelve la posición de la primera posición modificable situada después de la posición especificada utilizando la dirección de búsqueda indicada. Returns the position of the first editable position after the specified position using the specified search direction.

FindEditPositionInRange(Int32, Int32, Boolean)

Devuelve la posición de la primera posición modificable que se encuentre entre las posiciones especificadas utilizando la dirección de búsqueda indicada. Returns the position of the first editable position between the specified positions using the specified search direction.

FindNonEditPositionFrom(Int32, Boolean)

Devuelve la posición de la primera posición no modificable situada después de la posición especificada utilizando la dirección de búsqueda indicada. Returns the position of the first non-editable position after the specified position using the specified search direction.

FindNonEditPositionInRange(Int32, Int32, Boolean)

Devuelve la posición de la primera posición no modificable que se encuentre entre las posiciones especificadas utilizando la dirección de búsqueda indicada. Returns the position of the first non-editable position between the specified positions using the specified search direction.

FindUnassignedEditPositionFrom(Int32, Boolean)

Devuelve la posición de la primera posición modificable sin asignar situada después de la posición especificada utilizando la dirección de búsqueda indicada. Returns the position of the first unassigned editable position after the specified position using the specified search direction.

FindUnassignedEditPositionInRange(Int32, Int32, Boolean)

Devuelve la posición de la primera posición modificable sin asignar que se encuentre entre las posiciones especificadas utilizando la dirección de búsqueda indicada. Returns the position of the first unassigned editable position between the specified positions using the specified search direction.

GetHashCode()

Sirve como la función hash predeterminada. Serves as the default hash function.

(Inherited from Object)
GetOperationResultFromHint(MaskedTextResultHint)

Determina si la enumeración MaskedTextResultHint especificada denota éxito o error. Determines whether the specified MaskedTextResultHint denotes success or failure.

GetType()

Obtiene el Type de la instancia actual. Gets the Type of the current instance.

(Inherited from Object)
InsertAt(Char, Int32)

Inserta el carácter especificado en la posición indicada de la cadena con formato. Inserts the specified character at the specified position within the formatted string.

InsertAt(Char, Int32, Int32, MaskedTextResultHint)

Inserta el carácter especificado en la posición indicada de la cadena con formato y devuelve la última posición de inserción y el estado de la operación. Inserts the specified character at the specified position within the formatted string, returning the last insertion position and the status of the operation.

InsertAt(String, Int32)

Inserta la cadena especificada en la posición indicada de la cadena con formato. Inserts the specified string at a specified position within the formatted string.

InsertAt(String, Int32, Int32, MaskedTextResultHint)

Inserta la cadena especificada en la posición indicada de la cadena con formato y devuelve la última posición de inserción y el estado de la operación. Inserts the specified string at a specified position within the formatted string, returning the last insertion position and the status of the operation.

IsAvailablePosition(Int32)

Determina si la posición especificada está disponible para asignarse. Determines whether the specified position is available for assignment.

IsEditPosition(Int32)

Determina si la posición especificada es modificable. Determines whether the specified position is editable.

IsValidInputChar(Char)

Determina si el carácter especificado es un carácter de entrada válido. Determines whether the specified character is a valid input character.

IsValidMaskChar(Char)

Determina si el carácter especificado es un carácter de máscara válido. Determines whether the specified character is a valid mask character.

IsValidPasswordChar(Char)

Determina si el carácter especificado es un carácter de contraseña válido. Determines whether the specified character is a valid password character.

MemberwiseClone()

Crea una copia superficial del Object actual. Creates a shallow copy of the current Object.

(Inherited from Object)
Remove()

Quita el último carácter asignado de la cadena con formato. Removes the last assigned character from the formatted string.

Remove(Int32, MaskedTextResultHint)

Quita el último carácter asignado de la cadena con formato y, a continuación, genera información sobre la posición de eliminación e información descriptiva. Removes the last assigned character from the formatted string, and then outputs the removal position and descriptive information.

RemoveAt(Int32)

Quita el carácter asignado de la posición especificada de la cadena con formato. Removes the assigned character at the specified position from the formatted string.

RemoveAt(Int32, Int32)

Quita los caracteres asignados situados entre las posiciones especificadas de la cadena con formato. Removes the assigned characters between the specified positions from the formatted string.

RemoveAt(Int32, Int32, Int32, MaskedTextResultHint)

Quita los caracteres asignados situados entre las posiciones especificadas de la cadena con formato y, a continuación, genera información sobre la posición de eliminación e información descriptiva. Removes the assigned characters between the specified positions from the formatted string, and then outputs the removal position and descriptive information.

Replace(Char, Int32)

Reemplaza un carácter individual por el valor de carácter especificado en la posición indicada o más allá de la misma. Replaces a single character at or beyond the specified position with the specified character value.

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

Reemplaza un carácter individual situado entre las posiciones inicial y final especificadas por el valor de carácter especificado y, a continuación, genera información sobre la posición de eliminación e información descriptiva. Replaces a single character between the specified starting and ending positions with the specified character value, and then outputs the removal position and descriptive information.

Replace(Char, Int32, Int32, MaskedTextResultHint)

Reemplaza un único carácter situado en la posición especificada o más allá de la misma por el valor de carácter especificado y, a continuación, genera información sobre la posición de eliminación e información descriptiva. Replaces a single character at or beyond the specified position with the specified character value, and then outputs the removal position and descriptive information.

Replace(String, Int32)

Reemplaza un intervalo de caracteres modificables por la cadena especificada comenzando en la posición indicada. Replaces a range of editable characters starting at the specified position with the specified string.

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

Reemplaza un intervalo de caracteres modificables por la cadena especificada entre las posiciones inicial y final indicadas, y, a continuación, genera información sobre la posición de eliminación e información descriptiva. Replaces a range of editable characters between the specified starting and ending positions with the specified string, and then outputs the removal position and descriptive information.

Replace(String, Int32, Int32, MaskedTextResultHint)

Reemplaza un intervalo de caracteres modificables por la cadena especificada comenzando en la posición indicada y, a continuación, genera información sobre la posición de eliminación e información descriptiva. Replaces a range of editable characters starting at the specified position with the specified string, and then outputs the removal position and descriptive information.

Set(String)

Establece la cadena con formato en la cadena de entrada especificada. Sets the formatted string to the specified input string.

Set(String, Int32, MaskedTextResultHint)

Establece la cadena con formato en la cadena de entrada especificada y, a continuación, genera información sobre la posición de eliminación e información descriptiva. Sets the formatted string to the specified input string, and then outputs the removal position and descriptive information.

ToDisplayString()

Devuelve la cadena con formato en un formato que se pueda mostrar. Returns the formatted string in a displayable form.

ToString()

Devuelve la cadena con formato que contiene todos los valores de caracteres asignados. Returns the formatted string that includes all the assigned character values.

ToString(Boolean)

Devuelve la cadena con formato, que puede incluir los caracteres de contraseña. Returns the formatted string, optionally including password characters.

ToString(Boolean, Boolean)

Devuelve la cadena con formato, que puede incluir caracteres de petición de datos y caracteres literales. Returns the formatted string, optionally including prompt and literal characters.

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

Devuelve una subcadena de la cadena con formato, que puede incluir caracteres de petición de datos, caracteres literales y caracteres de contraseña. Returns a substring of the formatted string, optionally including prompt, literal, and password characters.

ToString(Boolean, Boolean, Int32, Int32)

Devuelve una subcadena de la cadena con formato, que puede incluir caracteres de petición de datos y caracteres literales. Returns a substring of the formatted string, optionally including prompt and literal characters.

ToString(Boolean, Int32, Int32)

Devuelve una subcadena de la cadena con formato, que puede incluir caracteres de contraseña. Returns a substring of the formatted string, optionally including password characters.

ToString(Int32, Int32)

Devuelve una subcadena de la cadena con formato. Returns a substring of the formatted string.

VerifyChar(Char, Int32, MaskedTextResultHint)

Comprueba si el carácter especificado se ha podido establecer correctamente en la posición indicada. Tests whether the specified character could be set successfully at the specified position.

VerifyEscapeChar(Char, Int32)

Comprueba si el carácter especificado sería un carácter de escape en la posición especificada. Tests whether the specified character would be escaped at the specified position.

VerifyString(String)

Comprueba si la cadena especificada ha podido establecerse correctamente. Tests whether the specified string could be set successfully.

VerifyString(String, Int32, MaskedTextResultHint)

Comprueba si la cadena especificada ha podido establecerse correctamente y, a continuación, genera información sobre la posición e información descriptiva. Tests whether the specified string could be set successfully, and then outputs position and descriptive information.

Se aplica a

Consultar también