Xamarin.Forms の複数バインド

[アーティクル]
10/26/2020

複数バインドを使用すると、Binding オブジェクトのコレクションを、1 つのバインディングターゲットのプロパティにアタッチできます。これらは MultiBinding クラスを使用して作成されます。このクラスでは、そのすべての Binding オブジェクトが評価され、アプリケーションによって提供される IMultiValueConverter インスタンスを介して 1 つの値が返されます。さらに、MultiBinding では、バインドされたデータのいずれかが変更されたときに、そのすべての Binding オブジェクトが再評価されます。

MultiBinding クラスには、次のプロパティが定義されています。

Bindings (IList<BindingBase> 型): MultiBinding インスタンス内の Binding オブジェクトのコレクションを表します。
Converter (IMultiValueConverter 型): ソース値とターゲット値との間の変換に使用するコンバーターを表します。
ConverterParameter (object 型): Converter に渡す省略可能なパラメーターを表します。

Bindings プロパティは MultiBinding クラスのコンテンツプロパティであるため、XAML から明示的に設定する必要はありません。

さらに、MultiBinding クラスは、BindingBase クラスから次のプロパティを継承します。

FallbackValue (object 型): 複数バインドから値を返すことができない場合に使用する値を表します。
Mode (BindingMode 型): 複数バインドのデータフローの方向を示します。
StringFormat (string 型): 複数バインドの結果が文字列として表示される場合に、どのように書式設定するかを指定します。
TargetNullValue (object 型): ソース値が null の場合に、ターゲットで使用される値を表します。

MultiBinding では、Bindings コレクション内のバインドの値に基づき、IMultiValueConverter を使用してバインディングターゲットの値を生成する必要があります。たとえば、Color は赤、青、および緑の値から計算できますが、これらは同じまたは異なるバインディングソースオブジェクトからの値にすることができます。ターゲットからソースに値が移動すると、ターゲットのプロパティ値は、バインドにフィードバックされる値のセットに変換されます。

重要

Bindings コレクション内の個々のバインドは、独自の値コンバーターを持つことができます。

Mode プロパティの値によって、MultiBinding の機能が決まります。これは、個々のバインドによってプロパティがオーバーライドされない限り、コレクション内のすべてのバインドでバインドモードとして使用されます。たとえば、MultiBinding オブジェクトの Mode プロパティが TwoWay に設定されている場合、いずれかのバインドで別の Mode 値を明示的に設定しない限り、コレクション内のすべてのバインドは TwoWay と見なされます。

IMultiValueConverter を定義する

IMultiValueConverter インターフェイスを使用すると、カスタムロジックを MultiBinding に適用できます。コンバーターを MultiBinding に関連付けるには、IMultiValueConverter インターフェイスを実装するクラスを作成し、Convert メソッドと ConvertBack メソッドを実装します。

public class AllTrueMultiConverter : IMultiValueConverter
{
    public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
    {
        if (values == null || !targetType.IsAssignableFrom(typeof(bool)))
        {
            return false;
            // Alternatively, return BindableProperty.UnsetValue to use the binding FallbackValue
        }

        foreach (var value in values)
        {
            if (!(value is bool b))
            {
                return false;
                // Alternatively, return BindableProperty.UnsetValue to use the binding FallbackValue
            }
            else if (!b)
            {
                return false;
            }
        }
        return true;
    }

    public object[] ConvertBack(object value, Type[] targetTypes, object parameter, CultureInfo culture)
    {
        if (!(value is bool b) || targetTypes.Any(t => !t.IsAssignableFrom(typeof(bool))))
        {
            // Return null to indicate conversion back is not possible
            return null;
        }

        if (b)
        {
            return targetTypes.Select(t => (object)true).ToArray();
        }
        else
        {
            // Can't convert back from false because of ambiguity
            return null;
        }
    }
}

Convert メソッドでは、ソース値がバインディングターゲットの値に変換されます。 Xamarin.Forms では、ソースバインドからの値をバインディングターゲットに伝達するときに、このメソッドが呼び出されます。このメソッドは、4 つの引数を受け取ります。

values (object[] 型): MultiBinding 内のソースバインドによって生成される値の配列。
targetType (Type 型): バインディングターゲットのプロパティの型。
parameter (object 型): 使用するコンバーターパラメーター。
culture (CultureInfo 型): コンバーターで使用するカルチャ。

Convert メソッドでは、変換された値を表す object が返されます。このメソッドでは、次を返す必要があります。

BindableProperty.UnsetValue: コンバーターによって値が生成されなかったこと、およびバインドで FallbackValue が使用されることを示す場合。
Binding.DoNothing: いかなる操作も実行しないように Xamarin.Forms に指示する場合。たとえば、バインディングターゲットに値を転送しないこと、または FallbackValue を使用しないことを Xamarin.Forms に指示する場合です。
null: コンバーターで変換を実行できないこと、およびバインドで TargetNullValue が使用されることを示す場合。

重要

Convert メソッドから BindableProperty.UnsetValue を受け取る MultiBinding では、FallbackValue プロパティを定義する必要があります。同様に、Convert メソッドから null を受け取る MultiBinding では、TargetNullValue プロパティを定義する必要があります。

ConvertBack メソッドでは、バインディングターゲットがソースバインドの値に変換されます。このメソッドは、4 つの引数を受け取ります。

value (object 型)。バインディングターゲットによって生成される値。
targetTypes (Type[] 型)。変換先の型の配列。配列の長さは、メソッドの戻り値として推奨されている値の数と型を示します。
parameter (object 型): 使用するコンバーターパラメーター。
culture (CultureInfo 型): コンバーターで使用するカルチャ。

ConvertBack メソッドでは、ターゲット値からソース値に変換された、object[] 型の値の配列が返されます。このメソッドでは、次を返す必要があります。

BindableProperty.UnsetValue (位置 i): コンバーターでインデックス i のソースバインドの値を提供することができず、値が設定されないことを示す場合。
Binding.DoNothing (位置 i): インデックス i のソースバインドに値が設定されないことを示す場合。
null: コンバーターで変換を実行できないこと、または、この方向の変換がサポートされていないことを示す場合。

IMultiValueConverter を使用する

IMultiValueConverter を使用するには、リソースディクショナリでインスタンス化した後、StaticResource マークアップ拡張を使用してそれを参照し、MultiBinding.Converter プロパティを設定します。

<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:local="clr-namespace:DataBindingDemos"
             x:Class="DataBindingDemos.MultiBindingConverterPage"
             Title="MultiBinding Converter demo">

    <ContentPage.Resources>
        <local:AllTrueMultiConverter x:Key="AllTrueConverter" />
        <local:InverterConverter x:Key="InverterConverter" />
    </ContentPage.Resources>

    <CheckBox>
        <CheckBox.IsChecked>
            <MultiBinding Converter="{StaticResource AllTrueConverter}">
                <Binding Path="Employee.IsOver16" />
                <Binding Path="Employee.HasPassedTest" />
                <Binding Path="Employee.IsSuspended"
                         Converter="{StaticResource InverterConverter}" />
            </MultiBinding>
        </CheckBox.IsChecked>
    </CheckBox>
</ContentPage>

この例では、MultiBinding オブジェクトによって AllTrueMultiConverter インスタンスを使用して CheckBox.IsChecked プロパティが true に設定されます (3 つの Binding オブジェクトが true に評価される場合)。それ以外の場合は、CheckBox.IsChecked プロパティは false に設定されます。

既定では、CheckBox.IsChecked プロパティでは TwoWay バインドが使用されます。したがって、AllTrueMultiConverter インスタンスの ConvertBack メソッドは、ユーザーが CheckBox をオフにしたときに実行されます。これにより、ソースバインドの値が CheckBox.IsChecked プロパティの値に設定されます。

これに相当する C# コードを次に示します。

public class MultiBindingConverterCodePage : ContentPage
{
    public MultiBindingConverterCodePage()
    {
        BindingContext = new GroupViewModel();

        CheckBox checkBox = new CheckBox();
        checkBox.SetBinding(CheckBox.IsCheckedProperty, new MultiBinding
        {
            Bindings = new Collection<BindingBase>
            {
                new Binding("Employee1.IsOver16"),
                new Binding("Employee1.HasPassedTest"),
                new Binding("Employee1.IsSuspended", converter: new InverterConverter())
            },
            Converter = new AllTrueMultiConverter()
        });

        Title = "MultiBinding converter demo";
        Content = checkBox;
    }
}

書式指定文字列

MultiBinding では、StringFormat プロパティを使用して、文字列として表示される複数バインドの結果を書式設定できます。このプロパティは、プレースホルダーを含む標準の .NET 書式設定文字列に設定できます。これによって、複数バインドの結果を書式設定する方法が指定されます。

<Label>
    <Label.Text>
        <MultiBinding StringFormat="{}{0} {1} {2}">
            <Binding Path="Employee1.Forename" />
            <Binding Path="Employee1.MiddleName" />
            <Binding Path="Employee1.Surname" />
        </MultiBinding>
    </Label.Text>
</Label>

この例では、StringFormat プロパティによって、3 つのバインドされた値が、Label によって表示される 1 つの文字列に結合されています。

これに相当する C# コードを次に示します。

Label label = new Label();
label.SetBinding(Label.TextProperty, new MultiBinding
{
    Bindings = new Collection<BindingBase>
    {
        new Binding("Employee1.Forename"),
        new Binding("Employee1.MiddleName"),
        new Binding("Employee1.Surname")
    },
    StringFormat = "{0} {1} {2}"
});

重要

複合文字列形式に含まれるパラメーターの数は、MultiBinding 内の子 Binding オブジェクトの数を超えることはできません。

Converter プロパティと StringFormat プロパティを設定する場合、最初にコンバーターがデータ値に適用され、その後 StringFormat が適用されます。

Xamarin.Forms での文字列の書式設定の詳細については、「Xamarin.Forms の文字列の書式設定」をご覧ください。

フォールバック値を指定する

バインドのプロセスが失敗した場合に使うフォールバック値を定義することにより、データバインディングをより堅牢にすることができます。これを実現するには、必要に応じて、MultiBinding オブジェクトの FallbackValue プロパティと TargetNullValue プロパティを定義します。

MultiBinding では、IMultiValueConverter インスタンスの Convert メソッドによって BindableProperty.UnsetValue が返された場合 (コンバーターで値が生成されなかったことを示します) に、その FallbackValue が使用されます。 MultiBinding では、IMultiValueConverter インスタンスの Convert メソッドによって null が返された場合 (コンバーターで変換を実行できないことを示します) に、その TargetNullValue が使用されます。

バインドのフォールバックの詳細については、「Xamarin.Forms のバインドのフォールバック」をご覧ください。

MultiBinding オブジェクトを入れ子にする

MultiBinding オブジェクトは入れ子にすることができます。これにより、複数の MultiBinding オブジェクトが評価され、IMultiValueConverter インスタンスを介して値が返されます。

<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:local="clr-namespace:DataBindingDemos"
             x:Class="DataBindingDemos.NestedMultiBindingPage"
             Title="Nested MultiBinding demo">

    <ContentPage.Resources>
        <local:AllTrueMultiConverter x:Key="AllTrueConverter" />
        <local:AnyTrueMultiConverter x:Key="AnyTrueConverter" />
        <local:InverterConverter x:Key="InverterConverter" />
    </ContentPage.Resources>

    <CheckBox>
        <CheckBox.IsChecked>
            <MultiBinding Converter="{StaticResource AnyTrueConverter}">
                <MultiBinding Converter="{StaticResource AllTrueConverter}">
                    <Binding Path="Employee.IsOver16" />
                    <Binding Path="Employee.HasPassedTest" />
                    <Binding Path="Employee.IsSuspended" Converter="{StaticResource InverterConverter}" />                        
                </MultiBinding>
                <Binding Path="Employee.IsMonarch" />
            </MultiBinding>
        </CheckBox.IsChecked>
    </CheckBox>
</ContentPage>

この例では、MultiBinding オブジェクトによって、その AnyTrueMultiConverter インスタンスを使用して CheckBox.IsChecked プロパティが true に設定されます (内部の MultiBinding オブジェクト内のすべての Binding オブジェクトが true に評価される場合、または外側の MultiBinding オブジェクト内の Binding オブジェクトが true に評価される場合)。それ以外の場合は、CheckBox.IsChecked プロパティは false に設定されます。

MultiBinding で RelativeSource バインドを使用する

MultiBinding オブジェクトでは相対バインドがサポートされています。これを使用すると、バインディングターゲットの位置を基準としてバインディングソースを設定することができます。

<ContentPage ...
             xmlns:local="clr-namespace:DataBindingDemos"
             xmlns:xct="clr-namespace:Xamarin.CommunityToolkit.UI.Views;assembly=Xamarin.CommunityToolkit">
    <ContentPage.Resources>
        <local:AllTrueMultiConverter x:Key="AllTrueConverter" />

        <ControlTemplate x:Key="CardViewExpanderControlTemplate">
            <xct:Expander BindingContext="{Binding Source={RelativeSource TemplatedParent}}"
                          IsExpanded="{Binding IsExpanded, Source={RelativeSource TemplatedParent}}"
                          BackgroundColor="{Binding CardColor}">
                <xct:Expander.IsVisible>
                    <MultiBinding Converter="{StaticResource AllTrueConverter}">
                        <Binding Path="IsExpanded" />
                        <Binding Path="IsEnabled" />
                    </MultiBinding>
                </xct:Expander.IsVisible>
                <xct:Expander.Header>
                    <Grid>
                        <!-- XAML that defines Expander header goes here -->
                    </Grid>
                </xct:Expander.Header>
                <Grid>
                    <!-- XAML that defines Expander content goes here -->
                </Grid>
            </xct:Expander>
        </ControlTemplate>
    </ContentPage.Resources>

    <StackLayout>
        <controls:CardViewExpander BorderColor="DarkGray"
                                   CardTitle="John Doe"
                                   CardDescription="Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla elit dolor, convallis non interdum."
                                   IconBackgroundColor="SlateGray"
                                   IconImageSource="user.png"
                                   ControlTemplate="{StaticResource CardViewExpanderControlTemplate}"
                                   IsEnabled="True"
                                   IsExpanded="True" />
    </StackLayout>
</ContentPage>

Note

Expander コントロールは、Xamarin Community Toolkit の一部になりました。

この例では、TemplatedParent 相対バインドモードを使用して、コントロールテンプレート内から、テンプレートが適用されるランタイムオブジェクトインスタンスへのバインドが行われています。 ControlTemplate のルート要素である Expander の BindingContext には、テンプレートが適用されるランタイムオブジェクトインスタンスが設定されています。そのため、Expander とその子によって、そのバインド式、および Binding オブジェクトが、CardViewExpander オブジェクトのプロパティに対して解決されます。 MultiBinding によって、AllTrueMultiConverter インスタンスを使用して Expander.IsVisible プロパティが true に設定されます (2 つの Binding オブジェクトが true に評価される場合)。それ以外の場合は、Expander.IsVisible プロパティは false に設定されます。

相対バインドの詳細については、「Xamarin.Forms の相対バインド」を参照してください。コントロールテンプレートの詳細については、「Xamarin.Forms のコントロールテンプレート」を参照してください。

次の方法で共有

Xamarin.Forms の複数バインド

IMultiValueConverter を定義する

IMultiValueConverter を使用する

書式指定文字列

フォールバック値を指定する

MultiBinding オブジェクトを入れ子にする

MultiBinding で RelativeSource バインドを使用する

その他のリソース

次の方法で共有

Xamarin.Forms の複数バインド

IMultiValueConverter を定義する

IMultiValueConverter を使用する

書式指定文字列

フォールバック値を指定する

MultiBinding オブジェクトを入れ子にする

MultiBinding で RelativeSource バインドを使用する

関連リンク

その他のリソース