EnumToIntConverter

Artigo
03/13/2024

O EnumToIntConverter é um conversor que permite converter um Enum padrão (estendendo o int) em seu tipoint primitivo subjacente. É útil ao associar uma coleção de valores que representam um tipo de enumeração com numeração padrão a um controle como um Picker.

Observação

A propriedade ConverterParameter é necessária e deve ser definida como o tipo da enumeração para a qual converter novamente, ao usar uma associação TwoWay ou OneWayToSource. Caso contrário, um ArgumentNullException será lançado. Isso é para permitir a verificação de se int é um valor válido na enumeração.

Para fins de localização ou devido a outros requisitos, os valores de enumeração geralmente precisam ser convertidos em uma cadeia de caracteres legível por humanos. Neste caso, quando o usuário seleciona um valor, o SelectedIndex resultante pode ser facilmente convertido no valor subjacente enum sem exigir trabalho adicional no ViewModel associado.

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

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 EnumToIntConverter

O EnumToIntConverter 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:vm="clr-namespace:CommunityToolkit.Maui.Sample.ViewModels.Converters"
             x:Class="MyLittleApp.MainPage">
    <ContentPage.Resources>
         <ResourceDictionary>
             <toolkit:EnumToIntConverter x:Key="EnumToIntConverter" />
         </ResourceDictionary>
    </ContentPage.Resources>

    <VerticalStackLayout Padding="10,10" Spacing="10">
            <Label Text="The EnumToIntConverter is a converter that allows users to convert a standard enum (extending int) to its underlying primitive int type." 
                   TextColor="{StaticResource NormalLabelTextColor}" />
            <Label Text="Selecting a value from the picker will change the enum property in the view model" 
                   TextColor="{StaticResource NormalLabelTextColor}" />
            <Picker ItemsSource="{Binding AllStates}" 
                    SelectedIndex="{Binding SelectedState, Converter={StaticResource EnumToIntConverter}, ConverterParameter={x:Type vm:IssueState}}"
                    TextColor="{StaticResource NormalLabelTextColor}" />
            <Label Text="This label binds to the SelectedIndex property of the picker, both use EnumToIntConverter, so no int properties are necessary in ViewModel"
                   TextColor="{StaticResource NormalLabelTextColor}" />
            <Label Text="{Binding Path=SelectedState, Converter={StaticResource EnumToIntConverter}}" 
                   TextColor="{StaticResource NormalLabelTextColor}" />
        </VerticalStackLayout>
</ContentPage>

C#

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

class EnumToIntConverterPage : ContentPage
{
    public EnumToIntConverterPage()
    {
        Picker picker = new Picker { Title = "EnumToIntConverter" };
        picker.SetBinding(Picker.ItemsSourceProperty, static (ViewModel vm) => vm .AllStates);
        picker.SetBinding(Picker.SelectedItemProperty, static (ViewModel vm) => vm.SelectedState);

        Content = new StackLayout
        {
            Margin = new Thickness(20),
            Children = 
            {
                new Label 
                {
                    Text = "The EnumToIntConverter is a converter that allows users to convert a standard enum (extending int) to its underlying primitive int type.",
                    FontAttributes = FontAttributes.Bold,
                    HorizontalOptions = LayoutOptions.Center 
                },
                picker
            }
        };
}

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 EnumToIntConverterPage : ContentPage
{
    public EnumToIntConverterPage()
    {
        Content = new StackLayout {
          new Picker()
            .Bind(
                Picker.ItemSourceProperty,
                static (ViewModel vm) => vm.AllStates)
            .Bind(
                Picker.SelectedIndexProperty,
                static (ViewModel vm) => vm.SelectedState),

          new Label()
            .Bind(
                Label.TextProperty,
                static (ViewModel vm) => vm.SelectedState,
                converter: new EnumToIntConverter()),
        }
    }
}

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 EnumToIntConverter pode ser encontrado no repositório GitHub do .NET MAUI Community Toolkit.

Compartilhar via