ColorToRgbStringConverter
ColorToRgbStringConverter
は、ユーザーが Color
値バインディングを、形式 RGB(red,green,blue) で相当する RGB string
に変換できるコンバーターです。ここで red、green、blue は 0 から 255 の値になり、たとえば Colors.Red
の場合は RGB(255,0,0) になります。
Convert
メソッドは、指定された Color
value
を相当する RGB string
に変換して返します。
ConvertBack
メソッドは、RGB string
value
を Color
に変換して返します。
BaseConverter プロパティ
基底クラス public abstract class BaseConverter
には、以下のプロパティが実装されています。
プロパティ | 説明 |
---|---|
DefaultConvertReturnValue |
IValueConverter.Convert(object?, Type, object?, CultureInfo?) が Exception をスローしたときに返される既定値。 この値は、CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters が true に設定されている場合に使用されます。 |
DefaultConvertBackReturnValue |
IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?) が Exception をスローしたときに返される既定値。 この値は、CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters が true に設定されている場合に使用されます。 |
ICommunityToolkitValueConverter プロパティ
public interface ICommunityToolkitValueConverter
には以下のプロパティが実装されています。
プロパティ | タイプ | 説明 |
---|---|---|
DefaultConvertReturnValue |
object? |
IValueConverter.Convert(object?, Type, object?, CultureInfo?) が Exception をスローしたときに返される既定値。 この値は、CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters が true に設定されている場合に使用されます。 |
DefaultConvertBackReturnValue |
object? |
IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?) が Exception をスローしたときに返される既定値。 この値は、CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters が true に設定されている場合に使用されます。 |
構文
次の例では、ColorToRgbStringConverter
を使用して、特定の Color
の相当する RGB 文字列を表示する方法を示します。
XAML
XAML 名前空間を含める
XAML でこのツールキットを使用するには、次の xmlns
をページまたはビューに追加する必要があります。
xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
したがって、以下のコードは、
<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>
次のように、xmlns
を含むように変更されます。
<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>
ColorToRgbStringConverter の使用
ColorToRgbStringConverter
は、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.ColorToRgbStringConverterPage">
<ContentPage.Resources>
<ResourceDictionary>
<toolkit:ColorToRgbStringConverter x:Key="ColorToRgbStringConverter" />
</ResourceDictionary>
</ContentPage.Resources>
<VerticalStackLayout>
<Label Text="My favourite Color is:" />
<Label Text="{Binding MyFavoriteColor, Converter={StaticResource ColorToRgbStringConverter}}" />
</VerticalStackLayout>
</ContentPage>
C#
ColorToRgbStringConverter
は、C# では次のように使用できます。
class ColorToRgbStringConverterPage : ContentPage
{
public ColorToRgbStringConverterPage()
{
var label = new Label();
label.SetBinding(
Label.TextProperty,
new Binding(
static (ViewModel vm) => vm.MyFavoriteColor,
converter: new ColorToRgbStringConverter()));
Content = new VerticalStackLayout
{
Children =
{
new Label { Text = "My favourite Color is:" },
label
}
};
}
}
C# Markup
この CommunityToolkit.Maui.Markup
パッケージは、C# でこのコンバーターを使用するためのより簡潔な方法を提供します。
using CommunityToolkit.Maui.Markup;
class ColorToRgbStringConverterPage : ContentPage
{
public ColorToRgbStringConverterPage()
{
Content = new VerticalStackLayout
{
Children =
{
new Label()
.Text("My favourite Color is:"),
new Label()
.Bind(
Label.TextProperty,
static (ViewModel vm) => vm.MyFavoriteColor,
converter: new ColorToRgbStringConverter())
}
};
}
}
例
このコンバーターの動作の例は「.NET MAUI Community Toolkit サンプル アプリケーション」で確認できます。
API
ColorToRgbStringConverter
のソース コードは、.NET MAUI Community Toolkit の GitHub リポジトリにあります。
.NET MAUI Community Toolkit