EnumToBoolConverter
EnumToBoolConverter
es un convertidor unidireccional que permite convertir un Enum
en un bool
correspondiente en función de si es igual a un conjunto de valores de enumeración proporcionados. Resulta útil al enlazar una colección de valores que representan un tipo de enumeración a una propiedad de control booleana como la propiedad IsVisible
.
El método Convert
devuelve el valor value
proporcionado convertido a un bool
basado en si value
es igual a cualquiera de los TrueValues
definicos o CommandParameter
proporcionados.
El método ConvertBack
no se admite.
Nota:
Tenga en cuenta que el valor "true" al que se va a comparar se puede proporcionar de las siguientes maneras:
- Como la propiedad
TrueValue
en el convertidor. - Como
ConverterParameter
en el enlace del convertidor.
Tenga en cuenta que la propiedad TrueValues
tendrá prioridad sobre la opción ConverterParameter
.
Propiedades de BaseConverter
Las siguientes propiedades se implementan en la clase base, public abstract class BaseConverter
:
Propiedad | Descripción |
---|---|
DefaultConvertReturnValue |
Valor predeterminado que se devuelve cuando IValueConverter.Convert(object?, Type, object?, CultureInfo?) produce una Exception . Este valor se usa cuando CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters está establecido en true . |
DefaultConvertBackReturnValue |
Valor predeterminado que se devuelve cuando IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?) produce una Exception . Este valor se usa cuando CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters está establecido en true . |
Propiedades de ICommunityToolkitValueConverter
Las siguientes propiedades se implementan en public interface ICommunityToolkitValueConverter
:
Propiedad | Tipo | Descripción |
---|---|---|
DefaultConvertReturnValue |
object? |
Valor predeterminado que se devuelve cuando IValueConverter.Convert(object?, Type, object?, CultureInfo?) produce una Exception . Este valor se usa cuando CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters está establecido en true . |
DefaultConvertBackReturnValue |
object? |
Valor predeterminado que se devuelve cuando IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?) produce una Exception . Este valor se usa cuando CommunityToolkit.Maui.Options.ShouldSuppressExceptionsInConverters está establecido en true . |
Sintaxis
Cada uno de los ejemplos siguientes usa la siguiente definición de enumeración:
namespace MyLittleApp;
public enum MyDevicePlatform
{
Android,
iOS,
macOS,
Tizen,
Windows
}
XAML
Incluir el espacio de nombres XAML
Para usar el kit de herramientas en XAML, es necesario agregar el siguiente xmlns
a la página o vista:
xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
Por lo tanto, el siguiente:
<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>
Se modificaría para incluir el xmlns
de la siguiente manera:
<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>
Uso de EnumToBoolConverter
El EnumToBoolConverter
se puede usar de la siguiente manera en 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"
xmlns:mylittleapp="clr-namespace:MyLittleApp"
x:Class="MyLittleApp.MainPage">
<ContentPage.Resources>
<ResourceDictionary>
<toolkit:EnumToBoolConverter x:Key="MobileConverter">
<toolkit:EnumToBoolConverter.TrueValues>
<mylittleapp:MyDevicePlatform>Android</mylittleapp:MyDevicePlatform>
<mylittleapp:MyDevicePlatform>iOS</mylittleapp:MyDevicePlatform>
</toolkit:EnumToBoolConverter.TrueValues>
</toolkit:EnumToBoolConverter>
</ResourceDictionary>
</ContentPage.Resources>
<VerticalStackLayout>
<Picker ItemsSource="{Binding Platforms}"
SelectedItem="{Binding SelectedPlatform}" />
<Label IsVisible="{Binding SelectedPlatform, Converter={StaticResource MobileConverter}}"
Text="I am visible when the Picker value is Android or iOS."/>
</VerticalStackLayout>
</ContentPage>
También es posible pasar el parámetro del convertidor:
<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="MyLittleApp.MainPage">
<ContentPage.Resources>
<ResourceDictionary>
<toolkit:EnumToBoolConverter x:Key="PlatformConverter" />
</ResourceDictionary>
</ContentPage.Resources>
<VerticalStackLayout>
<Picker ItemsSource="{Binding Platforms}"
SelectedItem="{Binding SelectedPlatform}" />
<Label IsVisible="{Binding SelectedPlatform, Converter={StaticResource PlatformConverter}, ConverterParameter={x:Static vm:MyDevicePlatform.Tizen}}"
Text="I am visible when the Picker value is Tizen."/>
</VerticalStackLayout>
</ContentPage>
C#
El EnumToBoolConverter
se puede usar de la siguiente manera en C#:
class EnumToBoolConverterPage : ContentPage
{
public EnumToBoolConverterPage()
{
var picker = new Picker();
picker.SetBinding(Picker.ItemsSourceProperty, static (ViewModel vm) => vm.Platforms);
picker.SetBinding(Picker.SelectedItemProperty, static (ViewModel vm) => vm.SelectedPlatform);
var label = new Label
{
Text = "I am visible when the Picker value is Tizen."
};
label.SetBinding(
Label.IsVisibleProperty,
new Binding(
static (ViewModel vm) => vm.SelectedPlatform,
converter: new EnumToBoolConverter(),
converterParameter: MyDevicePlatform.Tizen));
Content = new VerticalStackLayout
{
Children = { picker, label }
};
}
}
Marcado de C#
Nuestro paquete CommunityToolkit.Maui.Markup
proporciona una forma mucho más concisa de usar este convertidor en C#.
using CommunityToolkit.Maui.Markup;
class EnumToBoolConverterPage : ContentPage
{
public EnumToBoolConverterPage()
{
Content = new VerticalStackLayout
{
Children =
{
new Picker()
.Bind(
Picker.ItemsSourceProperty,
static (ViewModel vm) => vm.Platforms)
.Bind(
Picker.SelectedItemProperty,
static (ViewModel vm) => vm.SelectedPlatform),
new Label()
.Text("I am visible when the Picker value is Tizen.")
.Bind(
Label.IsVisibleProperty,
static (ViewModel vm) => vm.SelectedPlatform,
converter: new EnumToBoolConverter(),
converterParameter: MyDevicePlatform.Tizen)
}
};
}
}
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
TrueValues | IList<Enum> |
Valores de enumeración, que se convierten en true (opcional). |
Ejemplos
Puede encontrar un ejemplo de este convertidor en acción en la Aplicación de muestra del kit de herramientas de la comunidad de .NET MAUI.
API
Puede encontrar el código fuente de EnumToBoolConverter
en el repositorio de GitHub del Kit de herramientas de la comunidad de .NET MAUI.
.NET MAUI Community Toolkit