BoolToObjectConverter

Artigo
05/27/2024

O BoolToObjectConverter é um conversor que permite aos usuários converter uma ligação de valor bool para um objeto específico. Ao fornecer um TrueObject e um FalseObject no conversor, o objeto apropriado será retornado dependendo do valor da ligação.

O método Convert retorna TrueObject se o value fornecido for true ou FalseObject caso contrário.

O método ConvertBack retorna true se o value fornecido for igual a TrueObject ou false caso contrário.

Propriedades do BaseConverter

As seguintes propriedades são implementadas na classe base, public abstract class BaseConverter:

Propriedade	Descrição
`DefaultConvertReturnValue`	Valor padrão a ser retornado quando `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` lança um `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como`true`.
`DefaultConvertBackReturnValue`	Valor padrão a ser retornado quando `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` lança um `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como`true`.

Propriedades ICommunityToolkitValueConverter

As seguintes propriedades são implementadas no public interface ICommunityToolkitValueConverter:

Propriedade	Type	Descrição
`DefaultConvertReturnValue`	`object?`	Valor padrão a ser retornado quando `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` lança um `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como`true`.
`DefaultConvertBackReturnValue`	`object?`	Valor padrão a ser retornado quando `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` lança um `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como`true`.

Sintaxe

Os exemplos a seguir mostrarão como usar o BoolToObjectConverter para alterar a tela de fundo de um controle Entry com base no valor específico de uma propriedade associada IsValid sendo true ou false.

XAML

Incluir o namespace XAML

Para usar o kit de ferramentas no XAML, o xmlns a seguir precisa ser adicionado à sua página ou exibição:

xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"

Portanto, o seguinte:

<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>

Seria modificado para incluir o xmlns conforme o seguinte:

<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>

Usando o BoolToObjectConverter

O BoolToObjectConverter pode ser usado da seguinte maneira em 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#

O BoolToObjectConverter pode ser usado da seguinte maneira em 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;
    }
}

Markup do C#

Nosso pacote CommunityToolkit.Maui.Markup fornece uma maneira muito mais concisa de usar esse conversor no 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)
                });
    }
}

Exemplos

Você pode encontrar um exemplo desse conversor em ação no Aplicativo de amostra do Kit de Ferramentas do Comunidade do .NET MAUI.

API

O código-fonte do BoolToObjectConverter pode ser encontrado no repositório GitHub do .NET MAUI Community Toolkit.

Compartilhar via