ListToStringConverter

Article
03/18/2024

Le ListToStringConverter est un convertisseur unidirectionnel qui retourne une concaténation des membres d’une collection en utilisant le séparateur spécifié entre chaque membre.

La méthode Convert retourne une concaténation des membres d’une collection en utilisant le séparateur spécifié entre chaque membre.

Remarque

Notez que les séparateurs peuvent être fournis de la manière suivante :

En tant que ConverterParameter dans la liaison de convertisseur
En tant que propriété Separator sur le convertisseur

Notez que l’option ConverterParameter est prioritaire sur la propriété Separator.

La méthode ConvertBack n'est pas prise en charge. Pour le comportement opposé, voir le StringToListConverter.

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 à renvoyer lorsque `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` lève un `Exception`. Cette valeur est utilisée lorsque CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` est définie 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éfinie sur `true`.

Propriétés ICommunityToolkitValueConverter

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

Propriété	Type	Description
`DefaultConvertReturnValue`	`object?`	Valeur par défaut à renvoyer lorsque `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` lève un `Exception`. Cette valeur est utilisée lorsque CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` est définie 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éfinie 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>

Utilisation de ListToStringConverter

Le ListToStringConverter 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="CommunityToolkit.Maui.Sample.Pages.Converters.ListToStringConverterPage">

    <ContentPage.Resources>
        <ResourceDictionary>
            <toolkit:ListToStringConverter x:Key="ListToStringConverter" Separator="," />
        </ResourceDictionary>
    </ContentPage.Resources>

    <Label Text="{Binding MyListValue, Converter={StaticResource ListToStringConverter}}" />

</ContentPage>

C#

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

class ListToStringConverterPage : ContentPage
{
    public ListToStringConverterPage()
    {
        var label = new Label();

        label.SetBinding(
            Label.TextProperty,
            new Binding(
                static (ViewModels vm) => vm.MyListValue,
                converter: new ListToStringConverter() { Separator = "," }));

        Content = label;
    }
}

Balisage C#

Notre package CommunityToolkit.Maui.Markup offre une manière beaucoup plus concise d’utiliser ce convertisseur en C#.

using CommunityToolkit.Maui.Markup;

class ListToStringConverterPage : ContentPage
{
    public ListToStringConverterPage()
    {
        Content = new Label()
            .Bind(
                Label.TextProperty,
                static (ViewModel vm) => vm.MyListValue,
                converter: new ListToStringConverter(),
                converterParameter: ",");
    }
}

Propriétés

Propriété	Type	Description
Séparateur	`string`	Valeur qui sépare chaque élément de la collection. Cette valeur est remplacée par le ConverterParameter, s’il est fourni. Si ConverterParameter est nul, cette propriété de séparateur sera utilisée.

Exemples

Vous pouvez trouver un exemple de ce convertisseur en action dans l'exemple d'application de la boîte à outils de la communauté .NET MAUI.

API

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

Partager via