Obtiene o establece la máscara de entrada que se utilizará en tiempo de ejecución.
Espacio de nombres: System.Windows.Forms
Ensamblado: System.Windows.Forms (en system.windows.forms.dll)
Visual Basic (Declaración)
<LocalizableAttribute(True)> _
Public Property Mask As String
Dim instance As MaskedTextBox
Dim value As String
value = instance.Mask
instance.Mask = value
[LocalizableAttribute(true)]
public string Mask { get; set; }
[LocalizableAttribute(true)]
public:
property String^ Mask {
String^ get ();
void set (String^ value);
}
/** @property */
public String get_Mask ()
/** @property */
public void set_Mask (String value)
public function get Mask () : String
public function set Mask (value : String)
Valor de propiedad
String que representa la máscara actual. El valor predeterminado es la cadena vacía que permite cualquier entrada.
| Tipo de excepción | Condición |
|---|
ArgumentException | La cadena suministrada a la propiedad Mask no es una máscara válida. Entre las máscaras no válidas se incluyen las máscaras que contienen caracteres no imprimibles. |
Mask es la propiedad predeterminada para la clase MaskedTextBox.
Mask debe ser una cadena formada por uno o más de los elementos de enmascaramiento que se muestran en la tabla siguiente. Su MaskedTextProvider asociado define el lenguaje de enmascaramiento utilizado por MaskedTextBox. El proveedor estándar especifica un lenguaje de enmascaramiento basándose en el utilizado por el control Masked Edit en Visual Basic 6.0 y debe resultar muy familiar para los usuarios que estén migrando desde esa plataforma.
| Elemento de enmascaramiento | Descripción |
| 0 | Dígito, necesario. Este elemento aceptará cualquier dígito único entre 0 y 9. |
| 9 | Dígito o espacio, opcional. |
| # | Dígito o espacio, opcional. Si esta posición está en blanco en la máscara, se representará como un espacio en la propiedad Text. Se permiten los signos más (+) y menos (-). |
| L | Letra, necesaria. Restringe la entrada a las letras ASCII a-z y A-Z. Este elemento de máscara es equivalente a [a-zA-z] en las expresiones regulares. |
| ? | Letra, opcional. Restringe la entrada a las letras ASCII a-z y A-Z. Este elemento de máscara es equivalente a [a-zA-z]? en las expresiones regulares. |
| & | Carácter, necesaria. Si la propiedad AsciiOnly se establece en true, este elemento se comporta como el elemento "L". |
| C | Carácter, opcional. Cualquier carácter que no sea de control. Si la propiedad AsciiOnly se establece en true, este elemento se comporta como el elemento "?". |
| A | Alfanumérico, opcional. Si la propiedad AsciiOnly se establece en true, los únicos caracteres que aceptará son las letras ASCII a-z y A-Z. |
| a | Alfanumérico, opcional. Si la propiedad AsciiOnly se establece en true, los únicos caracteres que aceptará son las letras ASCII a-z y A-Z. |
| . | Marcador de posición de decimales. El carácter de presentación utilizado será el símbolo de posición de decimales apropiado para el proveedor de formato, según determine la propiedad FormatProvider del control. |
| , | Marcador de posición de miles. El carácter de presentación real utilizado será el marcador de posición de miles apropiado para el proveedor de formato, según determine la propiedad FormatProvider del control. |
| : | Separador de hora. El carácter de presentación utilizado será el símbolo de hora apropiado para el proveedor de formato, según determine la propiedad FormatProvider del control. |
| / | Separador de fecha. El carácter de presentación utilizado será el símbolo de fecha apropiado para el proveedor de formato, según determine la propiedad FormatProvider del control. |
| $ | Símbolo de moneda. El carácter real mostrado será el símbolo de moneda apropiado para el proveedor de formato, según determine la propiedad FormatProvider del control. |
| < | Minúsculas. Convierte en minúsculas todos los caracteres que hay a continuación. |
| > | Mayúsculas. Convierte en mayúsculas todos los caracteres que hay a continuación. |
| | | Deshabilitar un cambio anterior a mayúsculas o minúsculas. |
| \ | Escape. Convierte un carácter de la máscara en un literal. "\\" es la secuencia de escape para una barra diagonal inversa. |
| Todos los demás caracteres | Literales. Todos los elementos que no sean de la máscara aparecerán tal cual dentro de MaskedTextBox. Los literales siempre ocupan una posición estática en la máscara en tiempo de ejecución y el usuario no los puede desplazar ni eliminar. |
Si cambia una máscara cuando MaskedTextBox ya contiene datos proporcionados por el usuario filtrados por una máscara anterior, MaskedTextBox intentará migrar esa entrada a la nueva definición de máscara. Si se produce un error, borrará la entrada existente. Al asignar como máscara una cadena de longitud cero se conservarán los datos existentes en el control. Cuando se utiliza con una máscara de longitud cero, MaskedTextBox se comporta como un control TextBox de una única línea.
Los símbolos de decimales (.), miles (), hora (:), fecha (/) y moneda ($) se muestran de manera predeterminada según define esos símbolos la referencia cultural de la aplicación. Puede forzar que se muestren símbolos para otra referencia cultural si utiliza la propiedad FormatProvider.
La propiedad InsertKeyMode controla la inserción de caracteres en la máscara en tiempo de ejecución. Los usuarios pueden desplazarse por la máscara utilizando las teclas de flecha a la izquierda y flecha a la derecha o el cursor del mouse, y pueden omitir posiciones opcionales de la máscara escribiendo un espacio en blanco.
Importante: |
|---|
| MaskedTextBox admite todos los caracteres Unicode salvo los suplentes y los caracteres combinados verticalmente. |
En la tabla siguiente se muestran algunas máscaras de ejemplo.
| Máscara | Comportamiento |
| 00/00/0000 | Una fecha (día, mes numérico, año) en formato de fecha internacional. El carácter "/" es un separador de fecha lógico y aparecerá ante el usuario como el separador de fecha apropiado para la referencia cultural actual de la aplicación. |
| 00->L<LL-0000 | Una fecha (día, abreviatura del mes y año) en formato de Estados Unidos, en el que se muestra la abreviatura del mes de tres letras con una letra mayúscula inicial seguida de dos letras minúsculas. |
| (999)-000-0000 | Número de teléfono de Estados Unidos, código de área opcional. Si los usuarios no desean escribir los caracteres opcionales, pueden escribir espacios en blanco o pueden situar el puntero del mouse en la posición de la máscara representada por el primer 0. |
| $999,999.00 | Un valor de moneda en el intervalo de 0 a 999999. Los caracteres de moneda, miles y decimales se reemplazarán en tiempo de ejecución con sus equivalentes específicos de la referencia cultural. |
Windows 98, Windows 2000 Service Pack 4, Windows CE, Windows Millennium, Windows Mobile para Pocket PC, Windows Mobile para Smartphone, Windows Server 2003, Windows XP Media Center, Windows XP Professional x64, Windows XP SP2, Windows XP Starter
Microsoft .NET Framework 3.0 es compatible con Windows Vista, Microsoft Windows XP SP2 y Windows Server 2003 SP1.
.NET Framework
Compatible con: 3.0, 2.0