EnumToIntConverter

Článek
11/11/2023

Jedná se EnumToIntConverter o převaděč, který umožňuje převést standard Enum (rozšíření int) na jeho základní primitivní int typ. Je užitečné při vytváření vazby kolekce hodnot představující typ výčtu s výchozím číslováním na ovládací prvek, jako Pickerje například .

Poznámka:

Vlastnost ConverterParameter je povinná a měla by být nastavena na typ výčtu, na který se má převést zpět při použití TwoWay nebo OneWayToSource vazby. ArgumentNullException V opačném případě bude vyvolán. To umožňuje ověření, zda int je platná hodnota v výčtu.

Pro účely lokalizace nebo z důvodu jiných požadavků je často nutné převést hodnoty výčtu na řetězec čitelný pro člověka. V tomto případě, když uživatel vybere hodnotu, výsledek SelectedIndex lze snadno převést na podkladovou enum hodnotu bez nutnosti další práce v přidruženém modelu ViewModel.

BaseConverter – vlastnosti

V základní třídě jsou implementovány následující vlastnosti: public abstract class BaseConverter

Vlastnost	Popis
`DefaultConvertReturnValue`	Výchozí hodnota, která se má vrátit při `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` vyvolání .`Exception` Tato hodnota se používá, když Je nastavena možnost `true`CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` .
`DefaultConvertBackReturnValue`	Výchozí hodnota, která se má vrátit při `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` vyvolání .`Exception` Tato hodnota se používá, když Je nastavena možnost `true`CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` .

ICommunityToolkitValueConverter – vlastnosti

Následující vlastnosti jsou implementovány v public interface ICommunityToolkitValueConverter:

Vlastnost	Type	Popis
`DefaultConvertReturnValue`	`object?`	Výchozí hodnota, která se má vrátit při `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` vyvolání .`Exception` Tato hodnota se používá, když Je nastavena možnost `true`CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` .
`DefaultConvertBackReturnValue`	`object?`	Výchozí hodnota, která se má vrátit při `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` vyvolání .`Exception` Tato hodnota se používá, když Je nastavena možnost `true`CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` .

Syntaxe

XAML

Zahrnutí oboru názvů XAML

Pokud chcete použít sadu nástrojů v XAML, musíte do stránky nebo zobrazení přidat následující xmlns položky:

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

Proto platí následující:

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

Bylo by změněno tak, aby zahrnovalo xmlns následující:

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

Použití enumToIntConverter

V XAML je možné ho EnumToIntConverter použít následujícím způsobem:

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

V EnumToIntConverter jazyce C# je možné ho použít následujícím způsobem:

class EnumToIntConverterPage : ContentPage
{
    public EnumToIntConverterPage()
    {
      Picker picker = new Picker { Title = "EnumToIntConverter" };
      picker.SetBinding(Picker.ItemsSourceProperty, nameof(ViewModel.AllStates));
      picker.SetBinding(Picker.SelectedItemProperty, nameof(ViewModel.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
				}
			};
}

Revize jazyka C#

Náš CommunityToolkit.Maui.Markup balíček nabízí mnohem stručnější způsob použití tohoto převaděče v jazyce 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()),
        }
    }
}

Příklady

Příklad tohoto převaděče najdete v akci v ukázkové aplikaci .NET MAUI Community Toolkit.

rozhraní API

Zdrojový kód EnumToIntConverter najdete v úložišti .NET MAUI Community Toolkit na GitHubu.

Sdílet prostřednictvím