TextCaseConverter

Article
03/01/2023

The TextCaseConverter is a one way converter that allows users to convert the casing of an incoming string type binding. The Type property is used to define what kind of casing will be applied to the string.

The Convert method returns the supplied value converted to the defined TextCaseType. Note that the TextCaseType can be supplied in the following ways:

as the ConverterParameter in the converter binding,
as the Type property on the converter.

Note that the ConverterParameter option will take precedence over the Type property.

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

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 TextCaseConverter

The TextCaseConverter 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.TextCaseConverterPage">

    <ContentPage.Resources>
        <ResourceDictionary>
            <toolkit:TextCaseConverter x:Key="TextCaseConverter" Type="Upper" />
        </ResourceDictionary>
    </ContentPage.Resources>

    <Label Text="{Binding MyValue, Converter={StaticResource TextCaseConverter}}" />

</ContentPage>

C#

The TextCaseConverter can be used as follows in C#:


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

        label.SetBinding(
            Label.TextProperty,
            new Binding(
                static (ViewModels vm) => vm.MyValue,
                converter: new TextCaseConverter { Type = TextCaseType.Upper }));

        Content = 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 TextCaseConverterPage : ContentPage
{
    public TextCaseConverterPage()
    {
        Content = new Label()
            .Bind(
                Label.TextProperty,
                static (ViewModel vm) => vm.MyValue,
                converter: new TextCaseConverter { Type = TextCaseType.Upper });
    }
}

Properties

Property	Type	Description
Type	`TextCaseType`	The type of casing to apply to the `string` value.

TextCaseType

The TextCaseType enumeration defines the following members:

None - Applies no specific formatting to the string.
Upper - Applies upper case formatting to the string.
Lower - Applies lower case formatting to the string.
FirstUpperRestLower - Applies upper case formatting to the first character and then lower case formatting to the remaining string.

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 TextCaseConverter over on the .NET MAUI Community Toolkit GitHub repository.

Share via