MaskedTextBox.Mask Propriedade

Definição

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Obtém ou define a máscara de entrada a ser usada em tempo de execução.

public:
 property System::String ^ Mask { System::String ^ get(); void set(System::String ^ value); };

public string Mask { get; set; }

member this.Mask : string with get, set

Public Property Mask As String

Valor da propriedade

String

Um String que representa a máscara atual. O valor padrão é a cadeia de caracteres vazia, que permite qualquer entrada.

Exceções

ArgumentException

A cadeia de caracteres fornecida para a propriedade Mask não é uma máscara válida. Máscaras inválidas incluem máscaras que contêm caracteres não imprimíveis.

Comentários

Mask é a propriedade padrão para a MaskedTextBox classe .

Mask deve ser uma cadeia de caracteres composta por um ou mais dos elementos de mascaramento, conforme mostrado na tabela a seguir. A linguagem de mascaramento usada por MaskedTextBox é definida por seu associado MaskedTextProvider. O provedor padrão especifica uma linguagem de mascaramento com base na usada pelo controle Edição Mascarada no Visual Basic 6.0 e deve ser muito familiar para os usuários que migram dessa plataforma.

Elemento Masking	Descrição
0	Dígito, obrigatório. Esse elemento aceitará qualquer dígito único entre 0 e 9.
9	Dígito ou espaço, opcional.
#	Dígito ou espaço, opcional. Se essa posição estiver em branco na máscara, ela será renderizada como um espaço na Text propriedade . Mais (+) e menos (-) sinais são permitidos.
L	Carta, obrigatório. Restringe a entrada às letras ASCII a-z e A-Z. Esse elemento mask é equivalente a [a-zA-Z] em expressões regulares.
?	Letra, opcional. Restringe a entrada às letras ASCII a-z e A-Z. Esse elemento mask é equivalente a [a-zA-Z]? em expressões regulares.
&	Caractere, obrigatório. Se a AsciiOnly propriedade for definida como true, esse elemento se comportará como o elemento "L".
C	Caractere, opcional. Qualquer caractere sem controle. Se a AsciiOnly propriedade for definida como true, esse elemento se comportará como o elemento "?".
Um	Alfanumérico, obrigatório. Se a AsciiOnly propriedade estiver definida como true, os únicos caracteres que ela aceitará serão as letras ASCII a-z e A-Z. Esse elemento mask se comporta como o elemento "a".
um	Alfanumérico, opcional. Se a AsciiOnly propriedade estiver definida como true, os únicos caracteres que ela aceitará serão as letras ASCII a-z e A-Z. Esse elemento mask se comporta como o elemento "A".
.	Espaço reservado de decimal. O caractere de exibição real usado será o símbolo decimal apropriado para o provedor de formato, conforme determinado pela propriedade do FormatProvider controle.
,	Milhares de espaços reservados. O caractere de exibição real usado será o espaço reservado de milhares apropriado para o provedor de formato, conforme determinado pela propriedade do FormatProvider controle.
:	Separador de hora. O caractere de exibição real usado será o símbolo de tempo apropriado para o provedor de formato, conforme determinado pela propriedade do FormatProvider controle.
/	Separador de data. O caractere de exibição real usado será o símbolo de data apropriado para o provedor de formato, conforme determinado pela propriedade do FormatProvider controle.
$	Conversor de Moedas símbolo. O caractere real exibido será o símbolo de moeda apropriado para o provedor de formato, conforme determinado pela propriedade do FormatProvider controle.
<	Desloce para baixo. Converte todos os caracteres seguintes para minúsculo.
>	Mude para cima. Converte todos os caracteres seguintes para maiúsculo.
|	Desabilite um turno anterior para cima ou para baixo.
\	Escapar. Ignora qualquer caractere, transformando-o em um literal. "\\" é a sequência de escape de uma barra invertida.
Todos os outros caracteres	Literais Todos os elementos que não são máscaras aparecerão como eles mesmos dentro MaskedTextBox. Literais sempre ocupam uma posição estática na máscara em tempo de execução e não podem ser movidos ou excluídos pelo usuário.

Se você alterar uma máscara quando MaskedTextBox já contiver a entrada do usuário filtrada por uma máscara anterior, MaskedTextBox tentará migrar essa entrada para a nova definição de máscara. Se falhar, ele limpará a entrada existente. Atribuir uma cadeia de caracteres de comprimento zero como a máscara preservará todos os dados existentes no controle. Quando usado com uma máscara de comprimento zero, MaskedTextBox comporta-se como um controle de linha TextBox única.

Os símbolos decimal (.), milésimos (,), hora (:), data (/) e moeda ($) são padrão para exibir esses símbolos conforme definido pela cultura do aplicativo. Você pode forçá-los a exibir símbolos para outra cultura usando a FormatProvider propriedade.

A inserção de caracteres na máscara em tempo de execução é controlada pela InsertKeyMode propriedade . Os usuários podem navegar pela máscara usando as teclas de seta para a esquerda e direita ou o cursor do mouse e podem ignorar posições opcionais na máscara inserindo um espaço.

Importante

MaskedTextBox dá suporte a todos os caracteres Unicode, exceto para substitutos e caracteres combinados verticalmente.

A tabela a seguir mostra máscaras de exemplo.

Mask	Comportamento
00/00/0000	Uma data (dia, mês numérico, ano) no formato de data internacional. O caractere "/" é um separador de data lógica e aparecerá para o usuário como o separador de data apropriado para a cultura atual do aplicativo.
00->L<LL-0000	Uma data (dia, abreviação de mês e ano) no formato Estados Unidos em que a abreviação de mês de três letras é exibida com uma letra maiúscula inicial seguida por duas letras minúsculas.
(999)-000-0000	Estados Unidos número de telefone, código de área opcional. Se os usuários não quiserem inserir os caracteres opcionais, eles poderão inserir espaços ou colocar o ponteiro do mouse diretamente na posição na máscara representada pelos primeiros 0.
$999,999.00	Um valor de moeda no intervalo de 0 a 999999. A moeda, o milésimo e os caracteres decimais serão substituídos em tempo de execução por seus equivalentes específicos à cultura.

Confira também

• Text
• MaskFull
• MaskCompleted
• MaskChanged
• MaskedTextProvider