color-to-hsla-string-converter.md

title	author	description	ms.date
ColorToHslaStringConverter - .NET MAUI Community Toolkit	bijington	The ColorToHslaStringConverter is a one way converter that allows users to convert a Color value binding to its HSLA string equivalent.	04/15/2022

ColorToHslaStringConverter

The ColorToHslaStringConverter is a one way converter that allows users to convert a Color value binding to its HSLA string equivalent in the format: HSLA(hue,saturation,lightness,alpha) where hue will be a value between 0 and 360, saturation and lightness will be a value between 0% and 100%, and alpha will be a value between 0 and 1 (e.g. HSLA(0,100%,50%,1) for Colors.Red.

The Convert method returns the supplied Color value converted to its HSLA string equivalent.

The ConvertBack method is not supported.

[!INCLUDE common converter properties]

Syntax

The following examples will show how to use the ColorToHslaStringConverter to display the HSLA equivalent string of a specific Color.

XAML

Including the XAML namespace

[!INCLUDE XAML usage guidance]

Using the ColorToHslaStringConverter

The ColorToHslaStringConverter can be used as follows in 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#

The ColorToHslaStringConverter can be used as follows in C#:

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

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

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

C# Markup

Our CommunityToolkit.Maui.Markup package provides a much more concise way to use this converter in 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())
            }
        };
    }
}

Examples

You can find an example of this converter in action in the .NET MAUI Community Toolkit Sample Application.

API

You can find the source code for ColorToHslaStringConverter over on the .NET MAUI Community Toolkit GitHub repository.