ColorToDegreeHueConverter
The ColorToDegreeHueConverter
is a one way converter that allows users to convert an incoming Color
to the hue component as a value between 0 and 360. Hue is a degree on the color wheel from 0 to 360. 0 is red, 120 is green, 240 is blue.
The Convert
method returns the hue component as a value between 0 and 360 from the supplied value
.
The ConvertBack
method is not supported.
BaseConverter Properties
The following properties are implemented in the base class, public abstract class BaseConverter
:
Property | Description |
---|---|
DefaultConvertReturnValue |
Default value to return when IValueConverter.Convert(object?, Type, object?, CultureInfo?) throws an Exception . This value is used when CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters is set to true . |
DefaultConvertBackReturnValue |
Default value to return when IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?) throws an Exception . This value is used when CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters is set to true . |
ICommunityToolkitValueConverter Properties
The following properties are implemented in the public interface ICommunityToolkitValueConverter
:
Property | Type | Description |
---|---|---|
DefaultConvertReturnValue |
object? |
Default value to return when IValueConverter.Convert(object?, Type, object?, CultureInfo?) throws an Exception . This value is used when CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters is set to true . |
DefaultConvertBackReturnValue |
object? |
Default value to return when IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?) throws an Exception . This value is used when CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters is set to true . |
Syntax
The following examples will show how to use the ColorToDegreeHueConverter
to display the hue component of a specific Color
.
XAML
Including the XAML namespace
In order to use the toolkit in XAML the following xmlns
needs to be added into your page or view:
xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
Therefore the following:
<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>
Would be modified to include the xmlns
as follows:
<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>
Using the ColorToDegreeHueConverter
The ColorToDegreeHueConverter
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.ColorToDegreeHueConverterPage">
<ContentPage.Resources>
<ResourceDictionary>
<toolkit:ColorToDegreeHueConverter x:Key="ColorToDegreeHueConverter" />
</ResourceDictionary>
</ContentPage.Resources>
<VerticalStackLayout>
<Label Text="The hue component is:" />
<Label Text="{Binding MyFavoriteColor, Converter={StaticResource ColorToDegreeHueConverter}}" />
</VerticalStackLayout>
</ContentPage>
C#
The ColorToDegreeHueConverter
can be used as follows in C#:
class ColorToDegreeHueConverterPage : ContentPage
{
public ColorToDegreeHueConverterPage()
{
var label = new Label();
label.SetBinding(
Label.TextProperty,
new Binding(
nameof(ViewModel.MyFavoriteColor),
converter: new ColorToDegreeHueConverter()));
Content = new VerticalStackLayout
{
Children =
{
new Label { Text = "The hue component 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 ColorToDegreeHueConverterPage : ContentPage
{
public ColorToDegreeHueConverterPage()
{
Content = new VerticalStackLayout
{
Children =
{
new Label()
.Text("The hue component is:"),
new Label()
.Bind(
Label.TextProperty,
static (ViewModel vm) => vm.MyFavoriteColor,
converter: new ColorToDegreeHueConverter())
}
};
}
}
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 ColorToDegreeHueConverter
over on the .NET MAUI Community Toolkit GitHub repository.
.NET MAUI Community Toolkit