MaskedBehavior

O MaskedBehavior é um Behavior que permite que o usuário defina uma máscara de entrada para inserções de dados. Adicionar esse comportamento a um controle InputView(por exemplo, um Entry) forçará o usuário a apenas inserir valores de entrada correspondentes a uma determinada máscara. Exemplos de seu uso incluem a entrada de um número de cartão de crédito ou um número de telefone.

Importante

Os comportamentos do .NET MAUI Community Toolkit não definem o BindingContext de um comportamento, porque os comportamentos podem ser compartilhados e aplicados a vários controles por meio de estilos. Para mais informações confira Comportamentos do .NET MAUI

Sintaxe

Os exemplos a seguir mostram como adicionar o MaskedBehavior um Entry para ajudar um usuário ao inserir um número de cartão de crédito de 16 dígitos.

XAML

Incluir o namespace XAML

Para usar o kit de ferramentas no XAML, o xmlns a seguir precisa ser adicionado à sua página ou exibição:

xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"

Portanto, o seguinte:

<ContentPage
    x:Class="CommunityToolkit.Maui.Sample.Pages.MyPage"
    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml">

</ContentPage>

Seria modificado para incluir o xmlns conforme o seguinte:

<ContentPage
    x:Class="CommunityToolkit.Maui.Sample.Pages.MyPage"
    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
    xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit">

</ContentPage>

Como usar o MaskedBehavior

O MaskedBehavior pode ser usado da seguinte maneira em XAML:

<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
             x:Class="CommunityToolkit.Maui.Sample.Pages.Behaviors.MaskedBehaviorPage">

    <Entry Keyboard="Numeric">
        <Entry.Behaviors>
            <toolkit:MaskedBehavior Mask="XXXX XXXX XXXX XXXX" />
        </Entry.Behaviors>
    </Entry>

</ContentPage>

C#

O MaskedBehavior pode ser usado da seguinte maneira em C#:

class MaskedBehaviorPage : ContentPage
{
    public MaskedBehaviorPage()
    {
        var entry = new Entry
        {
            Keyboard = Keyboard.Numeric
        };

        var behavior = new MaskedBehavior
        {
            Mask = "XXXX XXXX XXXX XXXX"
        };

        entry.Behaviors.Add(behavior);

        Content = entry;
    }
}

Markup do C#

Nosso pacote CommunityToolkit.Maui.Markup disponibiliza uma forma muito mais concisa de usar esse Behavior em C#.

using CommunityToolkit.Maui.Markup;

class MaskedBehaviorPage : ContentPage
{
    public MaskedBehaviorPage()
    {
        Content = new Entry
        {
            Keyboard = Keyboard.Numeric
        }.Behaviors(new MaskedBehavior
        {
            Mask = "XXXX XXXX XXXX XXXX"
        });
    }
}

A captura de tela a seguir mostra o MaskedBehavior resultante no Android:

Caractere de prompt personalizado

É possível substituir o caractere na propriedade Mask que ficará visível para o usuário. Isso pode ser alterado definindo a propriedade UnmaskedCharacter que tem 'X' como padrão. Portanto, por exemplo, se fosse necessário exibir um X entre cada grupo de quatro dígitos em nossa entrada de cartão de crédito de 16 dígitos, o seguinte poderia ser usado:

<Entry Keyboard="Numeric">
    <Entry.Behaviors>
        <toolkit:MaskedBehavior Mask="0000X0000X0000X0000" UnmaskedCharacter="0" />
    </Entry.Behaviors>
</Entry>

Propriedades

Propriedade	Type	Descrição
Mask	string	A máscara que o valor de entrada precisa corresponder.
UnmaskedCharacter	char	Define qual caractere na propriedade Mask será visível e inserido por um usuário.

Exemplos

Você pode encontrar um exemplo desse comportamento em ação no Aplicativo de exemplo do .NET MAUI Community Toolkit.

API

O código-fonte do MaskedBehavior pode ser encontrado no repositório GitHub do .NET MAUI Community Toolkit.