CharactersValidationBehavior

[アーティクル]
04/04/2024

CharactersValidationBehavior は、指定されたパラメータに応じてユーザーがテキスト入力を検証できるようにする Behavior です。たとえば、Entry コントロールは、提供されたテキスト値が有効か無効かに応じて、異なるスタイルにできます。この動作には、特定の桁数や英数字のチェックなどの組み込みチェックが含まれます。

重要

.NET MAUI Community Toolkit のビヘイビアーでは、ビヘイビアーの BindingContext は設定されません。ビヘイビアーはスタイルを利用して共有し、複数のコントロールに適用できるためです。詳細については、「.NET MAUI のビヘイビアー」を参照してください

構文

次に示すのは、入力されたテキストに含まれるのが数字のみで 2 文字以上かどうかに基づいて、CharactersValidationBehavior を Entry に追加し、TextColor を変更する方法の例です。

XAML

XAML 名前空間を含める

XAML でこのツールキットを使用するには、次の xmlns をページまたはビューに追加する必要があります。

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

したがって、以下のコードは、

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

次のように、xmlns を含むように変更されます。

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

CharactersValidationBehavior の使用

CharactersValidationBehavior は、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#

CharactersValidationBehavior は、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;
    }
}

C# Markup

この CommunityToolkit.Maui.Markup パッケージは、C# でこの Behavior を使用するためのより簡潔な方法を提供します。

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

次のスクリーンショットは、Android での結果の CharactersValidationBehavior を示したものです。 Android 上の CharactersValidationBehavior のスクリーンショット

Properties

プロパティ	タイプ	説明
`CharacterType`	`CharacterType`	比較の処理方法を設定するために使用する列挙値を提供します。
`DecorationFlags`	`TextDecorationFlags`	空白の処理方法を設定するために使用する列挙値を提供します。
`MaximumCharacterTypeCount`	`int`	必要な `CharacterType` 文字の最大数。
`MaximumLength`	`int`	許可される値の最大長。
`MinimumCharacterTypeCount`	`int`	必要な `CharacterType` 文字の最小数。
`MinimumLength`	`int`	許可される値の最小長。
`RegexOptions`	`RegexOptions`	正規表現オプションを設定するために使用する列挙値を提供します。
`RegexPattern`	`string`	値が許可される前に一致する必要がある正規表現パターン。

ValidationBehavior のプロパティ

基底クラス public abstract class ValidationBehavior には、次のプロパティが実装されています。

プロパティ	タイプ	説明
`Flags`	`ValidationFlags`	検証の処理方法を指定する列挙値を提供します。
`ForceValidateCommand`	`ICommand`	検証の強制を処理するカスタムの `ICommand` をユーザーが提供できるようにします。
`InvalidStyle`	`Style`	検証が失敗した場合に要素に適用する `Style`。
`IsNotValid`	`bool`	現在の値が無効と見なされるかどうかを示します。
`IsRunning`	`bool`	検証が現在進行中 (非同期呼び出しの終了待ち) かどうかを示します。
`IsValid`	`bool`	現在の値が有効と見なされるかどうかを示します。
`ValidStyle`	`Style`	検証が成功した場合に要素に適用する `Style`。
`Value`	`object`	検証する値。
`ValuePropertyName`	`string`	検証対象の値として使用されるプロパティをユーザーがオーバーライドできるようにします。

例

このビヘイビアーの動作の例は .NET MAUI Community Toolkit サンプルアプリケーションで確認できます。

API

CharactersValidationBehavior のソースコードは、.NET MAUI Community Toolkit の GitHub リポジトリにあります。

次の方法で共有