CharactersValidationBehavior

O CharactersValidationBehavior é um Behavior que permite que o usuário valide a inserção de texto dependendo dos parâmetros especificados. Por exemplo, um controle Entry pode ser estilizado de forma diferente dependendo se um valor de texto válido ou inválido é fornecido. Esse comportamento inclui verificações internas, como verificar um determinado número de dígitos ou caracteres alfanuméricos.

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 CharactersValidationBehavior a um Entry e alterar TextColor com base em se o texto inserido contém apenas números e tem pelo menos 2 números.

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>

Usando o CharactersValidationBehavior

O CharactersValidationBehavior 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.CharactersValidationBehaviorPage">

    <ContentPage.Resources>
        <Style x:Key="InvalidEntryStyle" TargetType="Entry">
            <Setter Property="TextColor" Value="Red" />
        </Style>
        <Style x:Key="ValidEntryStyle" TargetType="Entry">
            <Setter Property="TextColor" Value="Green" />
        </Style>
    </ContentPage.Resources>

    <Entry>
        <Entry.Behaviors>
            <toolkit:CharactersValidationBehavior 
                InvalidStyle="{StaticResource InvalidEntryStyle}"
                ValidStyle="{StaticResource ValidEntryStyle}"
                Flags="ValidateOnValueChanged"
                CharacterType="Digit"
                MinimumCharacterTypeCount="3" />
        </Entry.Behaviors>
    </Entry>

</ContentPage>

C#

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

class CharactersValidationBehaviorPage : ContentPage
{
    public CharactersValidationBehaviorPage()
    {
        var entry = new Entry();

        var validStyle = new Style(typeof(Entry));
        validStyle.Setters.Add(new Setter
        {
            Property = Entry.TextColorProperty,
            Value = Colors.Green
        });

        var invalidStyle = new Style(typeof(Entry));
        invalidStyle.Setters.Add(new Setter
        {
            Property = Entry.TextColorProperty,
            Value = Colors.Red
        });

        var charactersValidationBehavior = new CharactersValidationBehavior
        {
            InvalidStyle = invalidStyle,
            ValidStyle = validStyle,
            Flags = ValidationFlags.ValidateOnValueChanged,
            CharacterType = CharacterType.Digit,
            MinimumCharacterTypeCount = 3
        };

        entry.Behaviors.Add(charactersValidationBehavior);

        Content = entry;
    }
}

Markup do C#

Nosso pacote CommunityToolkit.Maui.Markup fornece uma maneira muito mais concisa de usar este Behavior em C#.

using CommunityToolkit.Maui.Markup;

class CharactersValidationBehaviorPage : ContentPage
{
    public CharactersValidationBehaviorPage()
    {
        Content = new Entry()
            .Behaviors(new CharactersValidationBehavior
            {
                InvalidStyle = new Style<Entry>(Entry.TextColorProperty, Colors.Red),
                ValidStyle = new Style<Entry>(Entry.TextColorProperty, Colors.Green),
                Flags = ValidationFlags.ValidateOnValueChanged,
                CharacterType = CharacterType.Digit,
                MinimumCharacterTypeCount = 3
            });
    }
}

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

Propriedades

Propriedade	Type	Descrição
CharacterType	CharacterType	Fornece um valor enumerado a ser usado para definir como lidar com comparações.
DecorationFlags	TextDecorationFlags	Fornece um valor enumerado a ser usado para definir como lidar com espaços em branco.
MaximumCharacterTypeCount	int	O número máximo de caracteres CharacterType exigido.
MaximumLength	int	O comprimento máximo do valor que será permitido.
MinimumCharacterTypeCount	int	O número mínimo de caracteres CharacterType exigido.
MinimumLength	int	O comprimento mínimo do valor que será permitido.
RegexOptions	RegexOptions	Fornece valores enumerados para definir opções de expressão regular.
RegexPattern	string	O padrão de expressão regular que o valor precisará corresponder antes de ele ser permitido.

Propriedades de ValidationBehavior

As seguintes propriedades são implementadas na classe base public abstract class ValidationBehavior:

Propriedade	Type	Descrição
Flags	ValidationFlags	Fornece um valor enumerado que especifica como lidar com a validação.
ForceValidateCommand	ICommand	Permite que o usuário forneça um ICommand personalizado que lida com a validação forçada.
InvalidStyle	Style	O Style a ser aplicado ao elemento quando a validação falhar.
IsNotValid	bool	Indica se o valor atual é ou não considerado inválido.
IsRunning	bool	Indica se a validação está ou não em andamento agora (aguardando uma chamada assíncrona ser concluída).
IsValid	bool	Indica se o valor atual é ou não considerado válido.
ValidStyle	Style	O Style a ser aplicado ao elemento quando a validação for bem-sucedida.
Value	object	O valor a ser validado.
ValuePropertyName	string	Permite que o usuário substitua a propriedade que será usada como o valor a ser validado.

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 CharactersValidationBehavior pode ser encontrado no repositório GitHub do .NET MAUI Community Toolkit.