MaskedTextBox.Mask Propriedade

Definição

Espaço de Nomes:
System.Windows.Forms
Assemblagem:
System.Windows.Forms.dll
Origem:
MaskedTextBox.cs
Origem:
MaskedTextBox.cs
Origem:
MaskedTextBox.cs
Origem:
MaskedTextBox.cs
Origem:
MaskedTextBox.cs

Recebe ou define a máscara de entrada para 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 de Propriedade

String

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

Exceções

ArgumentException

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

Observações

Mask é a propriedade padrão da MaskedTextBox classe.

Mask deve ser uma cadeia composta por um ou mais elementos de mascaramento, como mostrado na tabela seguinte. A linguagem de mascaramento usada por MaskedTextBox é definida pelo seu associado MaskedTextProvider. O fornecedor padrão especifica uma linguagem de mascaramento baseada na usada pelo controlo Masked Edit no Visual Basic 6.0, e deve ser muito familiar para os utilizadores que migram dessa plataforma.

Elemento de mascaramento Descrição
0 Dígito, necessário. Este elemento aceita qualquer dígito entre 0 e 9.
9 Dígito ou espaço, opcional.
# Dígito ou espaço, opcional. Se esta posição estiver em branco na máscara, será renderizada como um espaço na Text propriedade. São permitidos sinais de mais (+) e menos (-).
L Carta, obrigatória. Restringe a entrada às letras ASCII a-z e A-Z. Este elemento de máscara é equivalente a [a-zA-Z] em expressões regulares.
? Carta, opcional. Restringe a entrada às letras ASCII a-z e A-Z. Este elemento de máscara é equivalente a [a-zA-Z]? em expressões regulares.
& Carácter, é necessário. Se a AsciiOnly propriedade for definida como verdadeira, este elemento comporta-se como o elemento "L".
C Personagem, opcional. Qualquer personagem que não seja de controlo. Se a AsciiOnly propriedade estiver definida como true, este elemento comporta-se como o elemento "?".
A Alfanumérico, obrigatório. Se a AsciiOnly propriedade estiver definida para true, os únicos caracteres que aceitará serão as letras ASCII a-z e A-Z. Este elemento máscara comporta-se como o elemento "a".
a Alfanumérico, opcional. Se a AsciiOnly propriedade estiver definida para true, os únicos caracteres que aceitará serão as letras ASCII a-z e A-Z. Este elemento da máscara comporta-se como o elemento "A".
. Espaço reservado decimal. O carácter de exibição real utilizado será o símbolo decimal apropriado ao fornecedor de formato, conforme determinado pela propriedade do FormatProvider controlo.
, Milhares provisórios. O carácter de exibição real utilizado será o número de milhares de marcadores apropriados ao fornecedor de formato, conforme determinado pela propriedade do FormatProvider controlo.
: Separador de tempo. O carácter de exibição real utilizado será o símbolo de tempo apropriado ao fornecedor de formato, determinado pela propriedade do FormatProvider controlo.
/ Separador de data. O carácter de exibição real utilizado será o símbolo de data apropriado ao fornecedor do formato, conforme determinado pela propriedade do FormatProvider controlo.
$ Símbolo da moeda. O carácter real apresentado será o símbolo monetário apropriado ao fornecedor do formato, conforme determinado pela propriedade do FormatProvider controlo.
< Descer a velocidade. Converte todos os caracteres seguintes em minúsculas.
> Muda de velocidade. Converte todos os caracteres seguintes em maiúsculas.
| Desativa um shift anterior para cima ou para baixo.
\ Fuga. Escapa de um personagem de máscara, transformando-o em um literal. "\\" é a sequência de escape usada para representar uma barra invertida.
Todos os outros personagens Literais. Todos os elementos que não sejam máscara aparecerão tal como são no MaskedTextBox. Os literais ocupam sempre uma posição estática na máscara durante a execução e não podem ser movidos ou eliminados pelo utilizador.

Se alterar uma máscara quando MaskedTextBox já contém entrada do utilizador filtrada por uma máscara anterior, MaskedTextBox tentará migrar essa entrada para a nova definição da máscara. Se falhar, irá limpar a entrada existente. Atribuir uma string de comprimento zero como máscara preservará quaisquer dados existentes no controlo. Quando usado com uma máscara de comprimento zero, MaskedTextBox comporta-se como um controlo de linha TextBox única.

Os símbolos decimal (.), milésimos (,), hora (:), data (/) e moeda ($) usam como padrão a exibição desses 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 utilizadores podem navegar pela máscara usando as setas esquerda e direita ou o cursor do rato, e podem saltar posições opcionais na máscara ao introduzir um espaço.

Importante

MaskedTextBox suporta todos os caracteres Unicode, exceto substitutos e caracteres verticalmente combinados.

A tabela seguinte mostra exemplos de máscaras.

Máscara Comportamento
00/00/0000 Uma data (dia, mês numérico, ano) em formato de data internacional. O carácter "/" é um separador lógico de datas e aparecerá ao utilizador como o separador de data apropriado à cultura atual da aplicação.
00->L<LL-0000 Uma data (dia, abreviatura de mês e ano) no formato dos Estados Unidos em que a abreviatura de três letras do mês é exibida com uma letra maiúscula inicial seguida de duas letras minúsculas.
(999)-000-0000 Número de telefone dos Estados Unidos, código de área opcional. Se os utilizadores não quiserem inserir os caracteres opcionais, podem inserir espaços ou colocar o ponteiro do rato diretamente na posição na máscara representada pelo primeiro 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 para a cultura.

Aplica-se a

Ver também