Compartir a través de


StringToListConverter

StringToListConverter es un convertidor unidireccional que devuelve un conjunto de subcadenas dividiendo la cadena de entrada en función de uno o varios separadores.

El método Convert devuelve un conjunto de subcadenas dividiendo la cadena de entrada en función de uno o varios separadores.

Nota:

Tenga en cuenta que los separadores se pueden proporcionar en el siguiente orden de prioridad:

  1. como ConverterParameter en el enlace del convertidor; esto reemplaza a las propiedades Separators y Separator
  2. como propiedad Separators en el convertidor; esto sustituye a la propiedad Separator
  3. como propiedad Separator en el convertidor.

No se admite el método ConvertBack. Para ver el comportamiento opuesto, vea ListToStringConverter.

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 StringToListConverter

El StringToListConverter 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.StringToListConverterPage">

    <ContentPage.Resources>
        <ResourceDictionary>
             <toolkit:StringToListConverter x:Key="StringToListConverter" SplitOptions="RemoveEmptyEntries">
                <toolkit:StringToListConverter.Separators>
                    <x:String>,</x:String>
                    <x:String>.</x:String>
                    <x:String>;</x:String>
                </toolkit:StringToListConverter.Separators>
            </toolkit:StringToListConverter>
        </ResourceDictionary>
    </ContentPage.Resources>

    <VerticalStackLayout>
        <Entry
            Placeholder="Enter some text separated by ',' or '.' or ';'"
            Text="{Binding MyValue}" />

        <CollectionView ItemsSource="{Binding MyValue, Converter={StaticResource StringToListConverter}}">
            <CollectionView.ItemTemplate>
                <DataTemplate>
                    <Label Text="{Binding .}" />
                </DataTemplate>
            </CollectionView.ItemTemplate>
        </CollectionView>
    </VerticalStackLayout>

</ContentPage>

C#

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

class StringToListConverterPage : ContentPage
{
    public StringToListConverterPage()
    {
        var entry = new Entry { Placeholder = "Enter some text separated by ',' or '.' or ';'" };
        entry.SetBinding(Entry.TextProperty, new Binding(static (ViewModel vm) => vm.MyValue));

        var stringToListConverter = new StringToListConverter
        {
            SplitOptions = System.StringSplitOptions.RemoveEmptyEntries,
            Separators = new [] { ",", ".", ";" }
        };

        var collectionView = new CollectionView
        {
            ItemTemplate = new DataTemplate(() =>
            {
                var itemLabel = new Label();
                itemLabel.SetBinding(Label.TextProperty, path: ".");
                return itemLabel;
            })
        };

        collectionView.SetBinding(
            CollectionView.ItemsSourceProperty,
            new Binding(
                static (ViewModel vm) => vm.MyValue,
                converter: stringToListConverter));

        Content = new VerticalStackLayout
        {
            Children =    
            {
                entry,
                collectionView
            }
        };
    }
}

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 StringToListConverterPage : ContentPage
{
    public StringToListConverterPage()
    {
        Content = new VerticalStackLayout
        {
            Children =    
            {
                new Entry { Placeholder = "Enter some text separated by ',' or '.' or ';'" }
                    .Bind(
                        Entry.TextProperty, 
                        static (ViewModel vm) => vm.MyValue),

                new CollectionView
                {
                    ItemTemplate = new DataTemplate(() => new Label().Bind(Label.TextProperty, path: Binding.SelfPath))
                }.Bind(
                    CollectionView.ItemsSourceProperty,
                    static (ViewModel vm) => vm.MyValue,
                    converter: new StringToListConverter
                    {
                        SplitOptions = System.StringSplitOptions.RemoveEmptyEntries,
                        Separators = new [] { ",", ".", ";" }
                    })
            }
        };
    }
}

Propiedades

Propiedad Tipo Descripción
Separador string Cadena que delimita las subcadenas de la cadena entrante. Este valor se sustituye por ConverterParameter y Separators. Si ConverterParameter es null y Separators está vacío, se usará este valor.
Separadores IList<string> Las cadenas que delimitan las subcadenas de la cadena entrante. Este valor se reemplaza por ConverterParameter. Si ConverterParameter es null este valor se usará.
SplitOptions StringSplitOptions Combinación bit a bit de los valores de enumeración que especifica si se deben recortar las subcadenas e incluir subcadenas vacías.

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