ColorToHslStringConverter

Artigo
03/16/2024

O ColorToHslStringConverter é um conversor unidirecional que permite que os usuários convertam uma associação de valor da Color em seu string HSL equivalente no formato: HSL(matiz, saturação, luminosidade) onde matiz será um valor entre 0 e 360, e saturação e luminosidade serão um valor entre 0% e 100% (por exemplo HSL(0,100%,50%) para Colors.Red.

O método Convert retorna o value de Color fornecido convertido em seu string HSL equivalente.

O método ConvertBack não tem suporte.

Propriedades do BaseConverter

As seguintes propriedades são implementadas na classe base, public abstract class BaseConverter:

Propriedade	Descrição
`DefaultConvertReturnValue`	Valor padrão a ser retornado quando `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` gera uma `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como `true`.
`DefaultConvertBackReturnValue`	Valor padrão a ser retornado quando `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` gera uma `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como `true`.

Propriedades do ICommunityToolkitValueConverter

As seguintes propriedades são implementadas no public interface ICommunityToolkitValueConverter:

Propriedade	Type	Descrição
`DefaultConvertReturnValue`	`object?`	Valor padrão a ser retornado quando `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` gera uma `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como `true`.
`DefaultConvertBackReturnValue`	`object?`	Valor padrão a ser retornado quando `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` gera uma `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como `true`.

Sintaxe

Os exemplos a seguir mostrarão como usar o ColorToHslStringConverter para exibir a cadeia de caracteres equivalente de HSL de um Color específico.

XAML

Incluir o namespace XAML

Para usar o kit de ferramentas no XAML, o xmlns a seguir precisa ser adicionado à sua página ou exibição:

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

Portanto, o seguinte:

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

Seria modificado para incluir o xmlns conforme o seguinte:

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

Usando o ColorToHslStringConverter

O ColorToHslStringConverter pode ser usado da seguinte maneira em 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#

O ColorToHslStringConverter pode ser usado da seguinte maneira em 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
		}
	};
    }
}

Markup do C#

Nosso pacote CommunityToolkit.Maui.Markup fornece uma maneira muito mais concisa de usar esse conversor em 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())
            }
        };
    }
}

Exemplos

Você pode encontrar um exemplo desse conversor em ação no Aplicativo de exemplo do .NET MAUI Community Toolkit.

API

O código-fonte do ColorToHslStringConverter pode ser encontrado no repositório GitHub do .NET MAUI Community Toolkit.

Compartilhar via