ColorToHslaStringConverter

Artigo
07/16/2024

O ColorToHslaStringConverter é um conversor unidirecional que permite aos usuários converter uma ligação de valor Color em seu equivalente HSLA string no formato: HSLA(hue,saturation,lightness,alpha) onde hue será um valor entre 0 e 360, saturação e luminosidade será um valor entre 0% e 100%, e alfa será um valor entre 0 e 1 (por exemplo, HSLA(0,100%,50%,1) para Colors.Red.

O método Convert retorna o Color value fornecido convertido no equivalente de HSLA string.

O método ConvertBack não é suportado.

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?)` lança um `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?)` lança um `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como`true`.

Propriedades 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?)` lança um `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?)` lança um `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como`true`.

Sintaxe

Os exemplos a seguir mostrarão como usar o ColorToHslaStringConverter para exibir a string equivalente HSLA de um determinado Color.

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 ColorToHslaStringConverter

O ColorToHslaStringConverter 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.ColorToHslaStringConverterPage">

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

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

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

</ContentPage>

C#

O ColorToHslaStringConverter pode ser usado da seguinte maneira em C#:

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

        label.SetBinding(
            Label.TextProperty,
            new Binding(
                static (ViewModel vm) => vm.MyFavoriteColor,
                converter: new ColorToHslaStringConverter()));

        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 no C#.

using CommunityToolkit.Maui.Markup;

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

Exemplos

Você pode encontrar um exemplo desse conversor em ação no Aplicativo de amostra do Kit de Ferramentas do Comunidade do .NET MAUI.

API

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

Compartilhar via