Compartir a través de


CompareConverter

CompareConverter es un convertidor unidireccional que toma un valor entrante que implementa IComparable, lo compara con un valor especificado y devuelve el resultado de la comparación. El resultado tendrá como valor predeterminado bool si no se especificó ningún objeto mediante las propiedades TrueObject o FalseObject. Si los valores se asignan a las propiedades TrueObject y/o FalseObject, CompareConverter devuelve el objeto correspondiente asignado.

Nota:

Tenga en cuenta que ambos, TrueObject y FalseObject, deben tener un valor definido o ninguno de ellos.

No se admite el método ConvertBack.

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

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 CompareConverter

El CompareConverter 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"
             x:Class="CommunityToolkit.Maui.Sample.Pages.Converters.CompareConverterPage">

    <ContentPage.Resources>
        <ResourceDictionary>
            <toolkit:CompareConverter
                x:Key="CompareConverter"
                ComparisonOperator="Smaller"
                ComparingValue="50"
                TrueObject="LightGreen"
                FalseObject="PaleVioletRed" />
        </ResourceDictionary>
    </ContentPage.Resources>

    <Label
        Text="The background of this label will be green if the value entered is less than 50, and red otherwise." 
        BackgroundColor="{Binding MyValue, Converter={StaticResource CompareConverter}" />

</ContentPage>

C#

El CompareConverter se puede usar de la siguiente manera en C#:


class CompareConverterPage : ContentPage
{
    public CompareConverterPage()
    {
        var label = new Label
        {
            Text = "The background of this label will be green if the value entered is less than 50, and red otherwise."
        };

        label.SetBinding(
            Label.BackgroundColorProperty,
            new Binding(
                nameof(ViewModel.MyValue),
                converter: new CompareConverter
                {
                    ComparisonOperator = OperatorType.Smaller,
                    ComparingValue = 50,
                    TrueObject = Colors.LightGreen,
                    FalseObject = Colors.PaleVioletRed
                }));

        Content = label;
    }
}

Marcado de C#

Nuestro paquete de CommunityToolkit.Maui.Markup proporciona una forma mucho más concisa de usar este convertidor en C#.

using CommunityToolkit.Maui.Markup;

class CompareConverterPage : ContentPage
{
    public CompareConverterPage()
    {
        Content = new Label()
            .Text("The background of this label will be green if the value entered is less than 50, and red otherwise.")
            .Bind(
                Label.BackgroundColorProperty,
                static (ViewModel vm) => vm.MyValue,
                converter: new CompareConverter
                {
                    ComparisonOperator = OperatorType.Smaller,
                    ComparingValue = 50,
                    TrueObject = Colors.LightGreen,
                    FalseObject = Colors.PaleVioletRed
                });
    }
}

Propiedades

Propiedad Tipo Descripción
ComparisonOperator OperatorType Tipo de mayúsculas y minúsculas que se va a aplicar al valor string.
ComparingValue IComparable Valor con el que se va a comparar.
FalseObject object Resultado que se va a devolver si la comparación da como resultado una comparación false.
TrueObject object Resultado que se va a devolver si la comparación da como resultado una comparación true.

TextCaseType

La enumeración OperatorType define los miembros siguientes:

  • NotEqual
  • Smaller
  • SmallerOrEqual
  • Equal
  • Greater
  • GreaterOrEqual

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 CompareConverter en el repositorio de GitHub del Kit de herramientas de la comunidad de .NET MAUI.