ColorConversionExtensions
The ColorConversionExtensions provide a series of extension methods that support converting, modifying or inspecting Colors.
The ColorConversionExtensions can be found under the CommunityToolkit.Maui.Core.Extensions namespace so just add the following line to get started:
using CommunityToolkit.Maui.Core.Extensions;
Convert Colors
The following methods allow you to convert the Color.
ToBlackOrWhite
The ToBlackOrWhite method converts the Color to a monochrome value of Colors.Black or Colors.White.
The following example shows how to convert Colors.Red to a monochrome value:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.ToBlackOrWhite();
ToBlackOrWhiteForText
The ToBlackOrWhiteForText method converts the Color to a monochrome value of Colors.Black or Colors.White based on whether the Color is determined as being dark for the human eye.
The following example shows how to convert Colors.Red to a monochrome value:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.ToBlackOrWhiteForText();
ToGrayScale
The ToGrayScale method converts the Color to a gray scale Color.
The following example shows how to convert Colors.Red to a gray scale value:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.ToGrayScale();
ToInverseColor
The ToInverseColor method inverts the Color.
The following example shows how to invert Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.ToInverseColor();
Determining Color darkness
The following methods allow you to determine whether the Color is considered dark.
IsDark
The IsDark method if the Color is dark.
The following example shows how to determine if Colors.Red is considered dark:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.IsDark();
IsDarkForTheEye
The IsDarkForTheEye method if the Color is dark for the human eye.
The following example shows how to determine if Colors.Red is considered dark for the human eye:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.IsDarkForTheEye();
Get Color components
The following methods allow you to obtain one of the components of the Color.
GetByteRed
The GetByteRed method get the red component of Color as a value between 0 and 255.
The following example shows how to get the red component of Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.GetByteRed();
GetByteGreen
The GetByteGreen method get the green component of Color as a value between 0 and 255.
The following example shows how to get the green component of Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.GetByteGreen();
GetByteBlue
The GetByteBlue method get the blue component of Color as a value between 0 and 255.
The following example shows how to get the blue component of Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.GetByteBlue();
GetDegreeHue
The GetDegreeHue method get the hue component of Color as a value between 0 and 360.
The following example shows how to get the hue component of Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.GetDegreeHue();
GetPercentCyan
The GetPercentCyan method get the cyan component of Color as a value between 0 and 1.
The following example shows how to get the cyan component of Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.GetPercentCyan();
GetPercentMagenta
The GetPercentMagenta method get the magenta component of Color as a value between 0 and 1.
The following example shows how to get the magenta component of Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.GetPercentMagenta();
GetPercentYellow
The GetPercentYellow method get the yellow component of Color as a value between 0 and 1.
The following example shows how to get the yellow component of Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.GetPercentYellow();
GetPercentBlackKey
The GetPercentBlackKey method get the black key component of Color as a value between 0 and 1.
The following example shows how to get the black key component of Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.GetPercentBlackKey();
GetByteAlpha
The GetByteAlpha method get the alpha component of Color as a value between 0 and 255.
The following example shows how to get the alpha component of Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.GetByteAlpha();
To Color string
The following methods allow you to convert the Color to a color scheme string.
ToCmykaString
The ToCmykaString method converts the Color to a string containing the cyan, magenta, yellow and key components. The resulting string will be in the format: CMYKA(cyan,magenta,yellow,key,alpha) where cyan, magenta, yellow and key will be a value between 0% and 100%, and alpha will be a value between 0 and 1 (e.g. CMYKA(0%,100%,100%,0%,1) for Colors.Red).
The following example shows how to convert Colors.Red to an CMYKA string:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.ToCmykaString();
Depends on the culture settings, alpha value may have different delimeter:
new Color(0, 0, 0, 0.5f).ToCmykaString(new System.Globalization.CultureInfo("en-US")); // returns "CMYKA(0%,0%,0%,100%,0.5)"
new Color(0, 0, 0, 0.5f).ToCmykaString(new System.Globalization.CultureInfo("uk-UA")); // returns "CMYKA(0%,0%,0%,100%,0,5)"
ToCmykString
The ToCmykString method converts the Color to a string containing the cyan, magenta, yellow and key components. The resulting string will be in the format: CMYK(cyan,magenta,yellow,key) where cyan, magenta, yellow and key will be a value between 0% and 100% (e.g. CMYK(0%,100%,100%,0%) for Colors.Red).
The following example shows how to convert Colors.Red to an CMYK string:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.ToCmykString();
ToHslaString
The ToHslaString method converts the Color to a string containing the cyan, magenta, yellow and key components. The resulting string will be in the format: HSLA(hue,saturation,lightness,alpha) where hue will be a value between 0 and 360, saturation and saturation 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 following example shows how to convert Colors.Red to an HSLA string:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.ToHslaString();
Depends on the culture settings, alpha value may have different delimeter:
new Color(0, 0, 0, 0.5f).ToHslaString(new System.Globalization.CultureInfo("en-US")); // returns "HSLA(0%,0%,0%,100%,0.5)"
new Color(0, 0, 0, 0.5f).ToHslaString(new System.Globalization.CultureInfo("uk-UA")); // returns "HSLA(0%,0%,0%,100%,0,5)"
ToHslString
The ToHslString method converts the Color to a string containing the cyan, magenta, yellow and key components. The resulting string will be in the format: HSL(hue,saturation,lightness) where hue will be a value between 0 and 360, saturation and saturation will be a value between 0% and 100% (e.g. HSL(0,100%,50%) for Colors.Red).
The following example shows how to convert Colors.Red to an HSL string:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.ToHslString();
ToRgbaString
The ToRgbaString method converts the Color to a string containing the red, green, blue and alpha components. The resulting string will be in the format: RGB(red,green,blue,alpha) where red, green and blue will be a value between 0 and 255, and alpha will be a value between 0 and 1 (e.g. RGBA(255,0,0,1) for Colors.Red).
The following example shows how to convert Colors.Red to an RGBA string:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.ToRgbaString();
Depends on the culture settings, alpha value may have different delimeter:
new Color(0, 0, 0, 0.5f).ToRgbaString(new System.Globalization.CultureInfo("en-US")); // returns "RGBA(0,0,0,0.5)"
new Color(0, 0, 0, 0.5f).ToRgbaString(new System.Globalization.CultureInfo("uk-UA")); // returns "RGBA(0,0,0,0,5)"
ToRgbString
The ToRgbString method converts the Color to a string containing the red, green and blue components. The resulting string will be in the format: RGB(red,green,blue) where red, green and blue will be a value between 0 and 255 (e.g. RGB(255,0,0) for Colors.Red).
The following example shows how to convert Colors.Red to an RGB string:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.ToRgbString();
With Color components
The following methods allow you to replace one of the components of the Color.
WithRed
The WithRed method applies the supplied redComponent to the Color. Note the redComponent can be a double between 0 and 1, or a byte between 0 and 255.
The following example shows how to apply the red component to Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.WithRed(0.5);
WithGreen
The WithGreen method applies the supplied greenComponent to the Color. Note the greenComponent can be a double between 0 and 1, or a byte between 0 and 255.
The following example shows how to apply the green component to Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.WithGreen(0.5);
WithBlue
The WithBlue method applies the supplied blueComponent to the Color. Note the blueComponent can be a double between 0 and 1, or a byte between 0 and 255.
The following example shows how to apply the blue component to Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.WithBlue(0.5);
WithCyan
The WithCyan method applies the supplied cyanComponent to the Color. Note the cyanComponent must be a value between 0 and 1.
The following example shows how to apply the cyan component to Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.WithCyan(0.5);
WithMagenta
The WithMagenta method applies the supplied magentaComponent to the Color. Note the magentaComponent must be a value between 0 and 1.
The following example shows how to apply the magenta component to Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.WithMagenta(0.5);
WithYellow
The WithYellow method applies the supplied yellowComponent to the Color. Note the yellowComponent must be a value between 0 and 1.
The following example shows how to apply the yellow component to Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.WithYellow(0.5);
WithBlackKey
The WithBlackKey method applies the supplied blackKeyComponent to the Color. Note the blackKeyComponent must be a value between 0 and 1.
The following example shows how to apply the black key component to Colors.Red:
using CommunityToolkit.Maui.Extensions.Core;
Colors.Red.WithBlackKey(0.5);
Examples
You can find an example of this extension in action in the .NET MAUI Community Toolkit Sample Application.
API
You can find the source code for ColorConversionExtensions over on the .NET MAUI Community Toolkit GitHub repository.
.NET MAUI Community Toolkit