Compartir a través de


EnumToIntConverter

EnumToIntConverter es un convertidor que permite convertir un estándar Enum (extender int) a su tipo primitivo int subyacente. Resulta útil al enlazar una colección de valores que representan un tipo de enumeración con numeración predeterminada a un control como Picker.

Nota:

Se requiere la propiedad ConverterParameter y debe establecerse en el tipo de enumeración a la que se va a convertir, al usar un enlace de TwoWay o OneWayToSource. De lo contrario, se producirá un ArgumentNullException. Esto permite validar si el int es un valor válido en la enumeración.

Para fines de localización o debido a otros requisitos, los valores de enumeración a menudo deben convertirse en una cadena legible. En este caso, cuando el usuario selecciona un valor, el SelectedIndex resultante se puede convertir fácilmente al valor de enum subyacente sin necesidad de trabajo adicional en el ViewModel asociado.

Propiedades de BaseConverter

Las siguientes propiedades se implementan en la clase base, public abstract class BaseConverter:

Propiedad Descripción
DefaultConvertReturnValue Valor predeterminado que se devuelve cuando IValueConverter.Convert(object?, Type, object?, CultureInfo?) produce una Exception. Este valor se usa cuando CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters se establece en true.
DefaultConvertBackReturnValue Valor predeterminado que se devuelve cuando IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?) produce una Exception. Este valor se usa cuando CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters se establece en true.

Propiedades de ICommunityToolkitValueConverter

Las siguientes propiedades se implementan en public interface ICommunityToolkitValueConverter:

Propiedad Tipo Descripción
DefaultConvertReturnValue object? Valor predeterminado que se devuelve cuando IValueConverter.Convert(object?, Type, object?, CultureInfo?) produce una Exception. Este valor se usa cuando CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters se establece en true.
DefaultConvertBackReturnValue object? Valor predeterminado que se devuelve cuando IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?) produce una Exception. Este valor se usa cuando CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters se establece en true.

Sintaxis

XAML

Incluir el espacio de nombres XAML

Para usar el kit de herramientas en XAML, es necesario agregar el siguiente xmlns a la página o vista:

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

Por lo tanto, el siguiente:

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

Se modificaría para incluir el xmlns de la siguiente manera:

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

Uso de EnumToIntConverter

El EnumToIntConverter se puede usar de la siguiente manera en 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#

El EnumToIntConverter se puede usar de la siguiente manera en 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
            }
        };
}

Marcado de C#

Nuestro paquete CommunityToolkit.Maui.Markup proporciona una forma mucho más concisa de usar este convertidor en 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()),
        }
    }
}

Ejemplos

Puede encontrar un ejemplo de este convertidor en acción en la Aplicación de muestra del kit de herramientas de la comunidad de .NET MAUI.

API

Puede encontrar el código fuente de EnumToIntConverter en el repositorio de GitHub del Kit de herramientas de la comunidad de .NET MAUI.