NumericValidationBehavior

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

NumericValidationBehavior は、テキスト入力が有効な数値であるかどうかをユーザーが判断できるようにする Behavior です。たとえば、指定された数値入力が有効か無効かに応じて、Entry コントロールのスタイルを変えることができます。

重要

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

構文

次の例は、入力された数値が無効である (1 から 100 の間ではない) と見なされた場合に、NumericValidationBehavior を 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>

NumericValidationBehavior の使用

NumericValidationBehavior は、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.NumericValidationBehaviorPage">

    <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 Keyboard="Numeric">
        <Entry.Behaviors>
            <toolkit:NumericValidationBehavior 
                InvalidStyle="{StaticResource InvalidEntryStyle}"
                ValidStyle="{StaticResource ValidEntryStyle}"
                Flags="ValidateOnValueChanged"
                MinimumValue="1.0"
                MaximumValue="100.0"
                MaximumDecimalPlaces="2" />
        </Entry.Behaviors>
    </Entry>

</ContentPage>

C#

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

class NumericValidationBehaviorPage : ContentPage
{
    public NumericValidationBehaviorPage()
    {
        var entry = new Entry
        {
            Keyboard = Keyboard.Numeric
        };

        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 numericValidationBehavior = new NumericValidationBehavior
        {
            InvalidStyle = invalidStyle,
            ValidStyle = validStyle,
            Flags = ValidationFlags.ValidateOnValueChanged,
            MinimumValue = 1.0,
            MaximumValue = 100.0,
            MaximumDecimalPlaces = 2
        };

        entry.Behaviors.Add(numericValidationBehavior);

        Content = entry;
    }
}

C# Markup

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

using CommunityToolkit.Maui.Markup;

class NumericValidationBehaviorPage : ContentPage
{
    public NumericValidationBehaviorPage()
    {
        Content = new Entry
        {
            Keyboard = Keyboard.Numeric
        }.Behaviors(new NumericValidationBehavior
        {
            InvalidStyle = new Style<Entry>(Entry.TextColorProperty, Colors.Red),
            ValidStyle = new Style<Entry>(Entry.TextColorProperty, Colors.Green),
            Flags = ValidationFlags.ValidateOnValueChanged,
            MinimumValue = 1.0,
            MaximumValue = 100.0,
            MaximumDecimalPlaces = 2
        });
    }
}

Properties

プロパティ	タイプ	説明
`MaximumDecimalPlaces`	`double`	許可される小数点以下の最大桁数。
`MinimumDecimalPlaces`	`double`	許可される小数点以下の最小桁数。
`MaximumValue`	`double`	許可される最大数値。
`MinimumValue`	`double`	許可される最小数値。

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

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

Share via