SelectedItemEventArgsConverter

Article
03/15/2024

SelectedItemEventArgsConverter est un convertisseur qui permet aux utilisateurs d’extraire la valeur SelectedItem d’un objet SelectedItemChangedEventArgs. Elle peut ensuite être utilisé en combinaison avec EventToCommandBehavior.

Propriétés BaseConverter

Les propriétés suivantes sont implémentées dans la classe de base, public abstract class BaseConverter :

Propriété	Description
`DefaultConvertReturnValue`	Valeur par défaut à retourner lorsque `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` lève une `Exception`. Cette valeur est utilisée lorsque CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` est défini sur `true`.
`DefaultConvertBackReturnValue`	Valeur par défaut à retourner lorsque `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` lève une `Exception`. Cette valeur est utilisée lorsque CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` est défini sur `true`.

Propriétés ICommunityToolkitValueConverter

Les propriétés suivantes sont implémentées dans les public interface ICommunityToolkitValueConverter :

Propriété	Type	Description
`DefaultConvertReturnValue`	`object?`	Valeur par défaut à retourner lorsque `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` lève une `Exception`. Cette valeur est utilisée lorsque CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` est défini sur `true`.
`DefaultConvertBackReturnValue`	`object?`	Valeur par défaut à retourner lorsque `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` lève une `Exception`. Cette valeur est utilisée lorsque CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` est défini sur `true`.

Syntaxe

XAML

Y compris l’espace de noms XAML

Pour utiliser le kit de ressources dans XAML, le xmlns suivant doit être ajouté à votre page ou à votre affichage :

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

Il en résulte ce qui suit :

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

Serait modifié pour inclure le xmlns de la manière suivante :

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

Utiliser SelectedItemEventArgsConverter

Le SelectedItemEventArgsConverter peut être utilisé de la manière suivante dans 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="MyLittleApp.MainPage">
    <ContentPage.Resources>
         <ResourceDictionary>
             <toolkit:SelectedItemEventArgsConverter x:Key="SelectedItemEventArgsConverter" />
         </ResourceDictionary>
    </ContentPage.Resources>

     <VerticalStackLayout Padding="10">

        <Label
            Text="The SelectedItemEventArgsConverter is a converter that allows users to extract the SelectedItem value from an SelectedItemChangedEventArgs object. It can subsequently be used in combination with EventToCommandBehavior."
            TextColor="{StaticResource NormalLabelTextColor}"
            Margin="0, 0, 0, 20" />

        <ListView
            BackgroundColor="Transparent"
            ItemsSource="{Binding Items}"
            SelectedItem="{Binding ItemSelected, Mode=TwoWay}">
            <ListView.ItemTemplate>
                <DataTemplate>
                    <ViewCell>
                        <VerticalStackLayout Margin="6">
                            <Label Text="{Binding Name, StringFormat='Name: {0}'}"/>
                        </VerticalStackLayout>
                    </ViewCell>
                </DataTemplate>
            </ListView.ItemTemplate>
            <ListView.Behaviors>
                <toolkit:EventToCommandBehavior EventName="ItemSelected"
                                                Command="{Binding ItemSelectedCommand}"
                                                EventArgsConverter="{StaticResource SelectedItemEventArgsConverter}" />
            </ListView.Behaviors>
        </ListView>
    </VerticalStackLayout>
</ContentPage>

C#

Le SelectedItemEventArgsConverter peut être utilisé de la manière suivante dans C# :

class SelectedItemEventArgsConverterPage : ContentPage
{
    public SelectedItemEventArgsConverterPage()
    {
        var behavior = new EventToCommandBehavior
        {
            EventName = nameof(ListView.ItemSelected),
            EventArgsConverter = new SelectedItemEventArgsConverter()
        };
        behavior.SetBinding(EventToCommandBehavior.CommandProperty, static (ViewModel vm) => vm.ItemSelectedCommand);

        var listView = new ListView 
        { 
            HasUnevenRows = true 
        };
        listView.SetBinding(ListView.ItemsSource, static (ViewModel vm) => vm.Items);
        listView.Behaviors.Add(behavior);

        Content = listView;
    }
}

Balisage C#

Notre package CommunityToolkit.Maui.Markup offre un moyen beaucoup plus concis d’utiliser ce convertisseur en C#.

using CommunityToolkit.Maui.Markup;

class SelectedItemEventArgsConverterPage : ContentPage
{
    public SelectedItemEventArgsConverterPage()
    {
        Content = new ListView
        {
            HasUnevenRows = true
        }
        .Bind(
            ListView.ItemsSourceProperty,
            static (ViewModel vm) => vm.Items)
        .Behaviors(
            new EventToCommandBehavior
            {
                EventName = nameof(ListView.ItemSelected),
                EventArgsConverter = new SelectedItemEventArgsConverter()
            }
            .Bind(
                EventToCommandBehavior.CommandProperty, 
                static (ViewModel vm) => vm.ItemTappedCommand));                   
    }
}

Exemples

Vous trouverez un exemple de ce convertisseur en action dans l’Exemple d’application du kit de ressources de la communauté .NET MAUI.

API

Vous pouvez trouver le code source deSelectedItemEventArgsConverter sur le référentiel du kit de ressources de la communauté .NET MAUI sur GitHub.

Partager via