TextValidationBehavior

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

TextValidationBehavior は、ユーザーが指定されたパラメータに応じて特定のテキストを検証できるようにする Behavior です。この動作をいずれかの InputView コントロールに追加すると、提供されたテキスト値が有効か無効かに応じて、異なるスタイルにすることができます。これには、特定の長さのチェックや、入力値が特定の正規表現と一致するかどうかなど、さまざまな組み込みチェックが用意されています。

重要

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

構文

次の例では、入力されたテキストが 1 から 10 文字の長さであるかどうかに基づいて、TextValidationBehavior を 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>

TextValidationBehavior を使用する

TextValidationBehavior は、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.TextValidationBehaviorPage">

    <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:TextValidationBehavior 
                InvalidStyle="{StaticResource InvalidEntryStyle}"
                ValidStyle="{StaticResource ValidEntryStyle}"
                Flags="ValidateOnValueChanged"
                MinimumLength="1"
                MaximumLength="10" />
        </Entry.Behaviors>
    </Entry>

</ContentPage>

C#

TextValidationBehavior は、C# では次のように使用できます。

class TextValidationBehaviorPage : ContentPage
{
    public TextValidationBehaviorPage()
    {
        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 textValidationBehavior = new TextValidationBehavior
        {
            InvalidStyle = invalidStyle,
            ValidStyle = validStyle,
            Flags = ValidationFlags.ValidateOnValueChanged,
            MinimumLength = 1,
            MaximumLength = 10
        };

        entry.Behaviors.Add(textValidationBehavior);

        Content = entry;
    }
}

C# Markup

この CommunityToolkit.Maui.Markup パッケージを使用すると、C# でこの Behavior をより簡潔な方法で使用できます。

using CommunityToolkit.Maui.Markup;

class TextValidationBehaviorPage : ContentPage
{
    public TextValidationBehaviorPage()
    {
        Content = new Entry()
            .Behaviors(new TextValidationBehavior
            {
                InvalidStyle = new Style<Entry>(Entry.TextColorProperty, Colors.Red),
                ValidStyle = new Style<Entry>(Entry.TextColorProperty, Colors.Green),
                Flags = ValidationFlags.ValidateOnValueChanged,
                MinimumLength = 1,
                MaximumLength = 10
            });
    }
}

次のスクリーンショットは、Android 上の結果の TextValidationBehavior を示しています。 Android 上の TextValidationBehavior のスクリーンショット

Properties

プロパティ	タイプ	説明
`DecorationFlags`	`TextDecorationFlags`	空白の処理方法を設定するために使用する列挙値を提供します。
`MaximumLength`	`int`	許可される値の最大長。
`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

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

次の方法で共有