CharactersValidationBehavior

CharactersValidationBehavior ist ein Behavior, das es Benutzer*innen ermöglicht, die Texteingabe abhängig von den angegebenen Parametern zu überprüfen. Beispielsweise kann ein Entry-Steuerelement unterschiedlich formatiert werden, je nachdem, ob ein gültiger oder ein ungültiger Text vorliegt. Dieses Verhalten enthält integrierte Überprüfungen, z. B. die Überprüfung auf eine bestimmte Anzahl von Ziffern oder alphanumerischen Zeichen.

Wichtig

.NET MAUI Community Toolkit Behaviors legt den BindingContext eines Verhaltens nicht fest, da Verhalten über Stile freigegeben und auf mehrere Steuerelemente angewendet werden können. Weitere Informationen finden Sie unter .NET MAUI Behaviors.

Syntax

In den folgenden Beispielen wird gezeigt, wie Sie den CharactersValidationBehavior zu einem Entry hinzufügen und TextColor basierend darauf ändern, ob der eingegebene Text nur Zahlen und mindestens 2 Zahlen enthält.

XAML

Einbinden des XAML-Namespace

Um das Toolkit in XAML verwenden zu können, muss der folgende xmlns-Abschnitt zu Ihrer Seite oder Ansicht hinzugefügt werden:

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

Der folgende Abschnitt:

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

Würde dann geändert werden, um xmlns einzubinden:

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

Verwenden des CharactersValidationBehavior

CharactersValidationBehavior kann wie folgt in XAML verwendet werden:

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

CharactersValidationBehavior kann wie folgt in C# verwendet werden:

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

C#-Markup

Das Paket CommunityToolkit.Maui.Markup bietet eine viel präzisere Möglichkeit, dieses Behavior in C# zu verwenden.

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
            });
    }
}

Der folgende Screenshot zeigt das resultierende ChractersValidationBehavior unter Android:

Eigenschaften

Eigenschaft	Typ	Beschreibung
CharacterType	CharacterType	Stellt einen aufgezählten Wert bereit, der festlegt, wie Vergleiche ausgeführt werden.
DecorationFlags	TextDecorationFlags	Stellt einen aufgezählten Wert bereit, der zum Festlegen verwendet werden soll, wie Leerzeichen behandelt werden.
MaximumCharacterTypeCount	int	Die maximale Anzahl der erforderlichen CharacterType-Zeichen.
MaximumLength	int	Die maximale Länge des zulässigen Werts.
MinimumCharacterTypeCount	int	Die minimale Anzahl der erforderlichen CharacterType-Zeichen.
MinimumLength	int	Die Mindestlänge des zulässigen Werts.
RegexOptions	RegexOptions	Stellt Enumerationswerte bereit, mit deren Hilfe Optionen für reguläre Ausdrücke festgelegt werden können.
RegexPattern	string	Das Muster für reguläre Ausdrücke, mit dem der Wert übereinstimmen muss, bevor er zulässig ist.

ValidationBehavior-Eigenschaften

Die folgenden Eigenschaften werden in der Basisklasse public abstract class ValidationBehavior implementiert:

Eigenschaft	Typ	Beschreibung
Flags	ValidationFlags	Stellt einen Enumerationswert bereit, der angibt, wie die Validierung behandelt werden soll.
ForceValidateCommand	ICommand	Ermöglicht es dem Benutzer, einen benutzerdefinierten ICommand bereitzustellen, der die Validierung erzwingt.
InvalidStyle	Style	Der Style, der auf das Element angewendet werden soll, wenn die Validierung fehlschlägt.
IsNotValid	bool	Gibt an, ob der aktuelle Wert als ungültig betrachtet wird oder nicht.
IsRunning	bool	Gibt an, ob die Validierung jetzt ausgeführt wird oder nicht (Warten auf einen asynchronen Aufruf ist beendet).
IsValid	bool	Gibt an, ob der aktuelle Wert als gültig betrachtet wird oder nicht.
ValidStyle	Style	Der Style, der auf das Element angewendet werden soll, wenn die Validierung erfolgreich ist.
Value	object	Der zu überprüfende Wert.
ValuePropertyName	string	Ermöglicht es dem Benutzer, die Eigenschaft außer Kraft zu setzen, die als Wert für die Validierung verwendet wird.

Beispiele

Sie finden ein Beispiel für dieses Verhalten in Aktion in der Beispielanwendung für das .NET MAUI Community Toolkit.

API

Sie finden den Quellcode für CharactersValidationBehavior über das GitHub-Repository für das .NET MAUI Community Toolkit.