ColorToHslStringConverter

Article
03/17/2024

Le ColorToHslStringConverter est un convertisseur unidirectionnel permettant aux utilisateurs de convertir une liaison de valeur Color en son équivalent TSL string au format : TSL (nuance, saturation, luminosité) où la nuance va être une valeur entre 0 et 360, la saturation et la luminosité vont être des pourcentages (par exemple TSL (0, 100 %, 50 %) pour Colors.Red.

La méthode Convert retourne le Colorvalue fourni converti en son équivalent string TSL.

La méthode ConvertBack n’est pas prise en charge.

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?)` génère 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?)` génère 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 public interface ICommunityToolkitValueConverter :

Propriété	Type	Description
`DefaultConvertReturnValue`	`object?`	Valeur par défaut à retourner lorsque `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` génère 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?)` génère une `Exception`. Cette valeur est utilisée lorsque CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` est défini sur `true`.

Syntaxe

Les exemples suivants montrent comment utiliser ColorToHslStringConverter pour afficher le TSL équivalent d’un Color spécifique.

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 ColorToHslStringConverter

Le ColorToHslStringConverter 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.ColorToHslStringConverterPage">

    <ContentPage.Resources>
        <ResourceDictionary>
            <toolkit:ColorToHslStringConverter x:Key="ColorToHslStringConverter" />
        </ResourceDictionary>
    </ContentPage.Resources>

    <VerticalStackLayout>
        <Label Text="My favourite Color is:" />

        <Label Text="{Binding MyFavoriteColor, Converter={StaticResource ColorToHslStringConverter}}" />
    </VerticalStackLayout>

</ContentPage>

C#

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

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

	label.SetBinding(
		Label.TextProperty,
		new Binding(
			nameof(ViewModel.MyFavoriteColor),
			converter: new ColorToHslStringConverter()));

	Content = new VerticalStackLayout
	{
		Children =
		{
			new Label { Text = "My favourite Color is:" },
			label
		}
	};
    }
}

Balisage C#

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

using CommunityToolkit.Maui.Markup;

class ColorToHslStringConverterPage : ContentPage
{
    public ColorToHslStringConverterPage()
    {
        Content = new VerticalStackLayout
        {
            Children =
            {
                new Label()
                    .Text("My favourite Color is:"),
                new Label()
                    .Bind(
                        Label.TextProperty,
                        static (ViewModel vm) => vm.MyFavoriteColor,
                        converter: new ColorToHslStringConverter())
            }
        };
    }
}

Exemples

Vous trouverez un exemple d’utilisation de ce convertisseur dans l’exemple d’application du kit d’outils de la communauté .NET MAUI.

API

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

Partager via