CompareConverter

[アーティクル]
03/19/2024

CompareConverter は、IComparable を実装する受信値を受け取り、指定された値と比較し、比較結果を返す一方向のコンバーターです。 TrueObject と FalseObject の両方またはいずれかのプロパティでオブジェクトが指定されていない場合、結果は既定で bool になります。 TrueObject と FalseObject の両方またはいずれかのプロパティに値が割り当てられている場合、CompareConverter は割り当てられたそれぞれのオブジェクトを返します。

Note

TrueObject と FalseObject の両方に値を定義するか、どちらも定義しない必要があることに注意してください。

ConvertBack メソッドはサポートされていません。

BaseConverter のプロパティ

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

プロパティ	説明
`DefaultConvertReturnValue`	`IValueConverter.Convert(object?, Type, object?, CultureInfo?)` が `Exception` をスローしたときに返される既定値です。この値は、CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` が `true` に設定されている場合に使用されます。
`DefaultConvertBackReturnValue`	`IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` が `Exception` をスローしたときに返される既定値です。この値は、CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` が `true` に設定されている場合に使用されます。

ICommunityToolkitValueConverter のプロパティ

public interface ICommunityToolkitValueConverter には次のプロパティが実装されています。

プロパティ	タイプ	説明
`DefaultConvertReturnValue`	`object?`	`IValueConverter.Convert(object?, Type, object?, CultureInfo?)` が `Exception` をスローしたときに返される既定値です。この値は、CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` が `true` に設定されている場合に使用されます。
`DefaultConvertBackReturnValue`	`object?`	`IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` が `Exception` をスローしたときに返される既定値です。この値は、CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` が `true` に設定されている場合に使用されます。

構文

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>

CompareConverter の使用

CompareConverter は、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.Converters.CompareConverterPage">

    <ContentPage.Resources>
        <ResourceDictionary>
            <toolkit:CompareConverter
                x:Key="CompareConverter"
                ComparisonOperator="Smaller"
                ComparingValue="50"
                TrueObject="LightGreen"
                FalseObject="PaleVioletRed" />
        </ResourceDictionary>
    </ContentPage.Resources>

    <Label
        Text="The background of this label will be green if the value entered is less than 50, and red otherwise." 
        BackgroundColor="{Binding MyValue, Converter={StaticResource CompareConverter}" />

</ContentPage>

C#

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


class CompareConverterPage : ContentPage
{
    public CompareConverterPage()
    {
        var label = new Label
        {
            Text = "The background of this label will be green if the value entered is less than 50, and red otherwise."
        };

        label.SetBinding(
            Label.BackgroundColorProperty,
            new Binding(
                nameof(ViewModel.MyValue),
                converter: new CompareConverter
                {
                    ComparisonOperator = OperatorType.Smaller,
                    ComparingValue = 50,
                    TrueObject = Colors.LightGreen,
                    FalseObject = Colors.PaleVioletRed
                }));

        Content = label;
    }
}

C# Markup

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

using CommunityToolkit.Maui.Markup;

class CompareConverterPage : ContentPage
{
    public CompareConverterPage()
    {
        Content = new Label()
            .Text("The background of this label will be green if the value entered is less than 50, and red otherwise.")
            .Bind(
                Label.BackgroundColorProperty,
                static (ViewModel vm) => vm.MyValue,
                converter: new CompareConverter
                {
                    ComparisonOperator = OperatorType.Smaller,
                    ComparingValue = 50,
                    TrueObject = Colors.LightGreen,
                    FalseObject = Colors.PaleVioletRed
                });
    }
}

Properties

プロパティ	タイプ	説明
ComparisonOperator	`OperatorType`	`string` 値に適用する大文字と小文字の種類。
ComparingValue	`IComparable`	比較する値。
FalseObject	`object`	比較結果が `false` 比較の場合に返される結果。
TrueObject	`object`	比較結果が `true` 比較の場合に返される結果。

TextCaseType

OperatorType 列挙型には、次のメンバーが定義されています。

NotEqual
Smaller
SmallerOrEqual
Equal
Greater
GreaterOrEqual

例

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

API

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

次の方法で共有