EnumToBoolConverter

O EnumToBoolConverter é um conversor unidirecional que permite converter um Enum em um bool correspondente com base em ele ser ou não igual a um conjunto de valores de enumeração fornecidos. É útil ao associar uma coleção de valores que representam um tipo de enumeração a uma propriedade de controle booliano como a propriedade IsVisible.

O método Convert retorna o value fornecido convertido em um bool com base em value ser ou não igual a qualquer um dos TrueValues definidos ou CommandParameter fornecidos.

Não há suporte para o método ConvertBack.

Observação

Observe que o valor "true" a ser comparado pode ser fornecido das seguintes maneiras:

1. como a propriedade TrueValue no conversor.
2. como o ConverterParameter na associação de conversor,

Observe que a propriedade TrueValues terá precedência sobre a opção ConverterParameter.

Propriedades de 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?) gera uma 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?) gera uma Exception. Esse valor é usado quando CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters é definido como true.

Propriedades de 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?) gera uma 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?) gera uma Exception. Esse valor é usado quando CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters é definido como true.

Sintaxe

Cada um dos exemplos a seguir usa a seguinte definição de enumeração:

namespace MyLittleApp;

public enum MyDevicePlatform
{
    Android,
    iOS,
    macOS,
    Tizen,
    Windows
}

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>

Usar o EnumToBoolConverter

O EnumToBoolConverter 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"
             xmlns:mylittleapp="clr-namespace:MyLittleApp"
             x:Class="MyLittleApp.MainPage">
    <ContentPage.Resources>
         <ResourceDictionary>
             <toolkit:EnumToBoolConverter x:Key="MobileConverter">
                <toolkit:EnumToBoolConverter.TrueValues>
                    <mylittleapp:MyDevicePlatform>Android</mylittleapp:MyDevicePlatform>
                    <mylittleapp:MyDevicePlatform>iOS</mylittleapp:MyDevicePlatform>
                </toolkit:EnumToBoolConverter.TrueValues>
            </toolkit:EnumToBoolConverter>
         </ResourceDictionary>
    </ContentPage.Resources>

    <VerticalStackLayout>
        <Picker ItemsSource="{Binding Platforms}"
                SelectedItem="{Binding SelectedPlatform}" />
        <Label IsVisible="{Binding SelectedPlatform, Converter={StaticResource MobileConverter}}"
               Text="I am visible when the Picker value is Android or iOS."/>
    </VerticalStackLayout>
</ContentPage>

Também é possível passar o parâmetro de conversor:

<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="MyLittleApp.MainPage">
    <ContentPage.Resources>
         <ResourceDictionary>
             <toolkit:EnumToBoolConverter x:Key="PlatformConverter" />
         </ResourceDictionary>
    </ContentPage.Resources>

    <VerticalStackLayout>
        <Picker ItemsSource="{Binding Platforms}"
                SelectedItem="{Binding SelectedPlatform}" />
        <Label IsVisible="{Binding SelectedPlatform, Converter={StaticResource PlatformConverter}, ConverterParameter={x:Static vm:MyDevicePlatform.Tizen}}"
               Text="I am visible when the Picker value is Tizen."/>
    </VerticalStackLayout>
</ContentPage>

C#

O EnumToBoolConverter pode ser usado da seguinte maneira em C#:

class EnumToBoolConverterPage : ContentPage
{
    public EnumToBoolConverterPage()
    {
        var picker = new Picker();
        picker.SetBinding(Picker.ItemsSourceProperty, static (ViewModel vm) => vm.Platforms);
        picker.SetBinding(Picker.SelectedItemProperty, static (ViewModel vm) => vm.SelectedPlatform);

        var label = new Label
        {
            Text = "I am visible when the Picker value is Tizen."
        };

        label.SetBinding(
            Label.IsVisibleProperty,
            new Binding(
                static (ViewModel vm) => vm.SelectedPlatform,
                converter: new EnumToBoolConverter(),
                converterParameter: MyDevicePlatform.Tizen));

        Content = new VerticalStackLayout
        {
            Children = { picker, label }
        };
    }
}

Markup do C#

Nosso pacote CommunityToolkit.Maui.Markup disponibiliza uma forma muito mais concisa de usar esse conversor em C#.

using CommunityToolkit.Maui.Markup;

class EnumToBoolConverterPage : ContentPage
{
    public EnumToBoolConverterPage()
    {
        Content = new VerticalStackLayout
        {
            Children = 
            {
                new Picker()
                    .Bind(
                        Picker.ItemsSourceProperty, 
                        static (ViewModel vm) => vm.Platforms)
                    .Bind(
                        Picker.SelectedItemProperty,
                        static (ViewModel vm) => vm.SelectedPlatform),

                new Label()
                    .Text("I am visible when the Picker value is Tizen.")
                    .Bind(
                        Label.IsVisibleProperty,
                        static (ViewModel vm) => vm.SelectedPlatform,
                        converter: new EnumToBoolConverter(),
                        converterParameter: MyDevicePlatform.Tizen)
            }
        };
    }
}

Propriedades

Propriedade	Type	Descrição
TrueValues	IList<Enum>	Enumerar valores, que são convertidos em true (opcional).

Exemplos

Encontre um exemplo desse conversor em ação no Aplicativo de exemplo do Kit de Ferramentas da Comunidade do .NET MAUI.

API

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