Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The IntToBoolConverter is a converter that allows users to convert an incoming int value to a bool and vice-versa.
The Convert method returns false if the supplied value is equal to 0 and true otherwise.
The ConvertBack method returns 1 if the supplied value is true and 0 otherwise.
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 IntToBoolConverter
The IntToBoolConverter 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.IntToBoolConverterPage">
<ContentPage.Resources>
<ResourceDictionary>
<toolkit:IntToBoolConverter x:Key="IntToBoolConverter" />
</ResourceDictionary>
</ContentPage.Resources>
<Label Text="The value is not zero."
IsVisible="{Binding MyValue, Converter={StaticResource IntToBoolConverter}}" />
</ContentPage>
C#
The IntToBoolConverter can be used as follows in C#:
class IntToBoolConverterPage : ContentPage
{
public IntToBoolConverterPage()
{
var label = new Label { Text = "The value is not zero." };
label.SetBinding(
Label.IsVisibleProperty,
new Binding(
static (ViewModels vm) => vm.MyValue,
converter: new IntToBoolConverter()));
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 IntToBoolConverterPage : ContentPage
{
public IntToBoolConverterPage()
{
Content = new Label { Text = "The value is not zero." }
.Bind(
Label.IsVisibleProperty,
static (ViewModel vm) => vm.MyValue,
converter: new IntToBoolConverter());
}
}
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 IntToBoolConverter over on the .NET MAUI Community Toolkit GitHub repository.
.NET MAUI Community Toolkit