RequiredStringValidationBehavior

O RequiredStringValidationBehavior é um Behavior que permite que o usuário determine se a inserção de texto é igual a um texto específico. Por exemplo, um controle Entry pode ser estilizado de maneira diferente, dependendo se uma entrada de texto válida ou inválida é fornecida.

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 RequiredStringValidationBehavior a uma Entry e alterar a TextColor com base em se a RequiredString foi inserida.

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 RequiredStringValidationBehavior

O RequiredStringValidationBehavior 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.RequiredStringValidationBehaviorPage">

    <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:RequiredStringValidationBehavior 
                InvalidStyle="{StaticResource InvalidEntryStyle}"
                ValidStyle="{StaticResource ValidEntryStyle}"
                Flags="ValidateOnValueChanged"
                RequiredString="MAGIC ANSWER" />
        </Entry.Behaviors>
    </Entry>

</ContentPage>

C#

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

class RequiredStringValidationBehaviorPage : ContentPage
{
    public RequiredStringValidationBehaviorPage()
    {
        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 requiredStringValidationBehavior = new RequiredStringValidationBehavior
        {
            InvalidStyle = invalidStyle,
            ValidStyle = validStyle,
            Flags = ValidationFlags.ValidateOnValueChanged,
            RequiredString = "MAGIC ANSWER"
        };

        entry.Behaviors.Add(requiredStringValidationBehavior);

        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 RequiredStringValidationBehaviorPage : ContentPage
{
    public RequiredStringValidationBehaviorPage()
    {
        Content = new Entry()
            .Behaviors(new RequiredStringValidationBehavior
            {
                InvalidStyle = new Style<Entry>(Entry.TextColorProperty, Colors.Red),
                ValidStyle = new Style<Entry>(Entry.TextColorProperty, Colors.Green),
                Flags = ValidationFlags.ValidateOnValueChanged,
                RequiredString = "MAGIC ANSWER"
            });
    }
}

A seguinte captura de tela mostra o RequiredStringValidationBehavior resultante no Android:

Propriedades

Propriedade	Type	Descrição
ExactMatch	bool	Determina se o texto inserido deve corresponder ao conteúdo inteiro da propriedade RequiredString ou simplesmente conter o valor da propriedade RequiredString.
RequiredString	string	A cadeia de caracteres que será comparada com o valor fornecido pelo usuário.

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