BoolToObjectConverter
BoolToObjectConverter
は、ユーザーが bool
値バインディングを特定のオブジェクトに変換できるコンバーターです。 コンバーターで TrueObject と FalseObject の両方を指定すると、バインディングの値に応じて適切なオブジェクトが返されます。
Convert
メソッドは、指定された value
が true
の場合は TrueObject
を、それ以外の場合は FalseObject
を返します。
ConvertBack
メソッドは、指定された value
が TrueObject
に等しい場合は true
を、それ以外の場合は false
を返します。
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 に設定されている場合に使用されます。 |
構文
次の例は、BoolToObjectConverter
を使って、バインドされたプロパティ IsValid
の特定の値が true
または false
のいずれであるかに基づいて Entry
コントロールの背景を変更する方法を示しています。
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>
BoolToObjectConverter の使用
BoolToObjectConverter
は、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.BoolToObjectConverterPage">
<ContentPage.Resources>
<ResourceDictionary>
<SolidColorBrush x:Key="TrueColorBrush">Green</SolidColorBrush>
<SolidColorBrush x:Key="FalseColorBrush">Red</SolidColorBrush>
<toolkit:BoolToObjectConverter x:Key="IsValidConverter"
TrueObject="{StaticResource TrueColorBrush}"
FalseObject="{StaticResource FalseColorBrush}"/>
</ResourceDictionary>
</ContentPage.Resources>
<Entry Background="{Binding IsValid, Converter={StaticResource IsValidConverter}}" />
</ContentPage>
C#
BoolToObjectConverter
は、C# では次のように使用できます。
class BoolToObjectConverterPage : ContentPage
{
public BoolToObjectConverterPage()
{
var entry = new Entry();
label.SetBinding(
Label.IsVisibleProperty,
new Binding(
static (ViewModel vm) => vm.IsValid,
converter: new BoolToObjectConverter
{
TrueObject = new SolidColorBrush(Colors.Green),
FalseObject = new SolidColorBrush(Colors.Red)
}));
Content = label;
}
}
C# Markup
この CommunityToolkit.Maui.Markup
パッケージは、C# でこのコンバーターを使用するためのより簡潔な方法を提供します。
using CommunityToolkit.Maui.Markup;
class BoolToObjectConverterPage : ContentPage
{
public BoolToObjectConverterPage()
{
Content = new Entry()
.Bind(
Label.BackgroundProperty,
static (ViewModel vm) => vm.IsValid,
converter: new BoolToObjectConverter
{
TrueObject = new SolidColorBrush(Colors.Green),
FalseObject = new SolidColorBrush(Colors.Red)
});
}
}
例
このコンバーターの動作の例は「.NET MAUI Community Toolkit サンプル アプリケーション」で確認できます。
API
BoolToObjectConverter
のソース コードは、.NET MAUI Community Toolkit の GitHub リポジトリにあります。
.NET MAUI Community Toolkit