RequiredStringValidationBehavior

Article
04/07/2024

Le RequiredStringValidationBehavior est un Behavior qui permet à l’utilisateur de déterminer si une entrée de texte est égale à un texte spécifique. Par exemple, un contrôle Entry peut avoir un style différent selon que l’entrée de texte fournie est valide ou non valide.

Important

Les comportements du Kit d’outils de la communauté .NET MAUI ne définissent pas le BindingContext d’un comportement, car ces comportements peuvent être partagés et appliqués à plusieurs contrôles par l’intermédiaire de styles. Pour obtenir plus d’informations, voir Comportements MAUI .NET

Syntaxe

Les exemples suivants montrent comment ajouter RequiredStringValidationBehavior à une Entry et modifier TextColor selon que RequiredStringa été saisi ou non.

XAML

Y compris l’espace de noms XAML

Pour utiliser le kit de ressources dans XAML, le xmlns suivant doit être ajouté à votre page ou à votre affichage :

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

Il en résulte ce qui suit :

<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>

Serait modifié pour inclure le xmlns de la manière suivante :

<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>

Utiliser RequiredStringValidationBehavior

Le RequiredStringValidationBehavior peut être utilisé de la manière suivante dans 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#

Le RequiredStringValidationBehavior peut être utilisé de la manière suivante dans 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;
    }
}

Balisage C#

Notre package CommunityToolkit.Maui.Markup permet d’utiliser ce Behavior de manière beaucoup plus concise en 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"
            });
    }
}

La capture d’écran suivante montre les résultats de RequiredStringValidationBehavior sur Android : Capture d’écran d’un comportement RequiredStringValidationBehavior sur Android

Propriétés

Propriété	Type	Description
`ExactMatch`	`bool`	Détermine si le texte entré doit correspondre à l’intégralité du contenu de la propriété `RequiredString` ou simplement contenir la valeur de la propriété `RequiredString`.
`RequiredString`	`string`	Chaîne qui sera comparée à la valeur fournie par l’utilisateur.

Propriétés ValidationBehavior

Les propriétés suivantes sont implémentées dans la classe de base, public abstract class ValidationBehavior :

Propriété	Type	Description
`Flags`	`ValidationFlags`	Fournit une valeur énumérée qui spécifie comment gérer la validation.
`ForceValidateCommand`	`ICommand`	Permet à l’utilisateur de fournir une commande `ICommand` personnalisée qui gère le forçage de validation.
`InvalidStyle`	`Style`	`Style` à appliquer à l’élément en cas d’échec de la validation.
`IsNotValid`	`bool`	Indique si la valeur actuelle est considérée ou non comme non valide.
`IsRunning`	`bool`	Indique si la validation est en cours (en attente de la fin d’un appel asynchrone) ou non.
`IsValid`	`bool`	Indique si la valeur actuelle est considérée ou non comme valide.
`ValidStyle`	`Style`	`Style` à appliquer à l’élément en cas de réussite de la validation.
`Value`	`object`	Valeur à valider.
`ValuePropertyName`	`string`	Permet à l’utilisateur de remplacer la propriété qui sera utilisée comme valeur à valider.

Exemples

Vous trouverez un exemple de ce comportement en action dans l’Exemple d’application du kit de ressources de la communauté .NET MAUI.

API

Vous pouvez trouver le code source deRequiredStringValidationBehavior sur le référentiel du kit de ressources de la communauté .NET MAUI sur GitHub.

Partager via