Xamarin. Forms CollectionView EmptyViewXamarin.Forms CollectionView EmptyView

Baixar Exemplo Baixar o exemploDownload Sample Download the sample

CollectionView Define as propriedades a seguir que podem ser usadas para fornecer comentários do usuário quando não há nenhum dado para exibir:CollectionView defines the following properties that can be used to provide user feedback when there's no data to display:

  • EmptyView, do tipo object, a cadeia de caracteres, a associação ou o modo de exibição que será exibido quando o ItemsSource é de propriedade null, ou quando a coleção especificada pelo ItemsSource propriedade é null ou está vazio.EmptyView, of type object, the string, binding, or view that will be displayed when the ItemsSource property is null, or when the collection specified by the ItemsSource property is null or empty. O valor padrão é null.The default value is null.
  • EmptyViewTemplate, do tipo DataTemplate , o modelo a ser usado para formatar especificado EmptyView.EmptyViewTemplate, of type DataTemplate, the template to use to format the specified EmptyView. O valor padrão é null.The default value is null.

Essas propriedades têm o respaldo BindableProperty objetos, o que significa que as propriedades podem ser alvos de vinculações de dados.These properties are backed by BindableProperty objects, which means that the properties can be targets of data bindings.

Os cenários de uso principal para a configuração de EmptyView propriedade estiver exibindo comentários do usuário quando uma operação de filtragem em uma CollectionView produz sem dados e exibir comentários do usuário ao dados estão sendo recuperados de um serviço web.The main usage scenarios for setting the EmptyView property are displaying user feedback when a filtering operation on a CollectionView yields no data, and displaying user feedback while data is being retrieved from a web service.

Observação

O EmptyView propriedade pode ser definida como uma exibição que inclui conteúdo interativo, se necessário.The EmptyView property can be set to a view that includes interactive content if required.

Para obter mais informações sobre modelos de dados, confira Modelos de dados do Xamarin.Forms.For more information about data templates, see Xamarin.Forms Data Templates.

Exibir uma cadeia de caracteres quando dados não estão disponíveisDisplay a string when data is unavailable

O EmptyView propriedade pode ser definida como uma cadeia de caracteres, que será exibido quando o ItemsSource propriedade é null, ou quando a coleção especificada pelo ItemsSource propriedade é null ou está vazio.The EmptyView property can be set to a string, which will be displayed when the ItemsSource property is null, or when the collection specified by the ItemsSource property is null or empty. O XAML a seguir mostra um exemplo desse cenário:The following XAML shows an example of this scenario:

<CollectionView ItemsSource="{Binding EmptyMonkeys}"
                EmptyView="No items to display" />

O código C# equivalente é:The equivalent C# code is:

CollectionView collectionView = new CollectionView
{
    EmptyView = "No items to display"
};
collectionView.SetBinding(ItemsView.ItemsSourceProperty, "EmptyMonkeys");

O resultado é que, como os dados associados a coleção é null, a cadeia de caracteres é definido como o EmptyView valor da propriedade é exibido:The result is that, because the data bound collection is null, the string set as the EmptyView property value is displayed:

Captura de tela de uma lista vertical de CollectionView com uma exibição vazia de texto, no iOS e AndroidScreenshot of a CollectionView vertical list with a text empty view, on iOS and Android

Exibir modos de exibição quando dados não estão disponíveisDisplay views when data is unavailable

O EmptyView propriedade pode ser definida como um modo de exibição, que será exibido quando o ItemsSource propriedade é null, ou quando a coleção especificada pelo ItemsSource propriedade é null ou está vazio.The EmptyView property can be set to a view, which will be displayed when the ItemsSource property is null, or when the collection specified by the ItemsSource property is null or empty. Isso pode ser uma única exibição ou uma exibição que contém vários modos de exibição filho.This can be a single view, or a view that contains multiple child views. A exemplo XAML a seguir mostra o EmptyView propriedade definida como uma exibição que contém vários modos de exibição filho:The following XAML example shows the EmptyView property set to a view that contains multiple child views:

<StackLayout Margin="20">
    <SearchBar x:Name="searchBar"
               SearchCommand="{Binding FilterCommand}"
               SearchCommandParameter="{Binding Source={x:Reference searchBar}, Path=Text}"
               Placeholder="Filter" />
    <CollectionView ItemsSource="{Binding Monkeys}">
        <CollectionView.ItemTemplate>
            <DataTemplate>
                ...
            </DataTemplate>
        </CollectionView.ItemTemplate>
        <CollectionView.EmptyView>
            <StackLayout>
                <Label Text="No results matched your filter."
                       Margin="10,25,10,10"
                       FontAttributes="Bold"
                       FontSize="18"
                       HorizontalOptions="Fill"
                       HorizontalTextAlignment="Center" />
                <Label Text="Try a broader filter?"
                       FontAttributes="Italic"
                       FontSize="12"
                       HorizontalOptions="Fill"
                       HorizontalTextAlignment="Center" />
            </StackLayout>
        </CollectionView.EmptyView>
    </CollectionView>
</StackLayout>

O código C# equivalente é:The equivalent C# code is:

SearchBar searchBar = new SearchBar { ... };
CollectionView collectionView = new CollectionView
{
    EmptyView = new StackLayout
    {
        Children =
        {
            new Label { Text = "No results matched your filter.", ... },
            new Label { Text = "Try a broader filter?", ... }
        }
    }
};
collectionView.SetBinding(ItemsView.ItemsSourceProperty, "Monkeys");

Quando o SearchBar executa o FilterCommand, a coleção exibida pelo CollectionView é filtrado para o termo de pesquisa são armazenados no SearchBar.Text propriedade.When the SearchBar executes the FilterCommand, the collection displayed by the CollectionView is filtered for the search term stored in the SearchBar.Text property. Se a operação de filtragem não produz nenhum dado, o StackLayout definido como o EmptyView valor da propriedade é exibido:If the filtering operation yields no data, the StackLayout set as the EmptyView property value is displayed:

Captura de tela de uma lista vertical de CollectionView com exibição personalizada de vazia no iOS e AndroidScreenshot of a CollectionView vertical list with custom empty view, on iOS and Android

Exibir um tipo de modelo personalizado quando dados não estão disponíveisDisplay a templated custom type when data is unavailable

O EmptyView propriedade pode ser definida como um tipo personalizado, cujo modelo é exibido quando o ItemsSource propriedade é null, ou quando a coleção especificada, o ItemsSourceé de propriedade null ou está vazio.The EmptyView property can be set to a custom type, whose template is displayed when the ItemsSource property is null, or when the collection specified by the ItemsSource property is null or empty. O EmptyViewTemplate propriedade pode ser definida como um DataTemplate que define a aparência do EmptyView.The EmptyViewTemplate property can be set to a DataTemplate that defines the appearance of the EmptyView. O XAML a seguir mostra um exemplo desse cenário:The following XAML shows an example of this scenario:

<StackLayout Margin="20">
    <SearchBar x:Name="searchBar"
               SearchCommand="{Binding FilterCommand}"
               SearchCommandParameter="{Binding Source={x:Reference searchBar}, Path=Text}"
               Placeholder="Filter" />
    <CollectionView ItemsSource="{Binding Monkeys}">
        <CollectionView.ItemTemplate>
            <DataTemplate>
                ...
            </DataTemplate>
        </CollectionView.ItemTemplate>
        <CollectionView.EmptyView>
            <views:FilterData Filter="{Binding Source={x:Reference searchBar}, Path=Text}" />
        </CollectionView.EmptyView>
        <CollectionView.EmptyViewTemplate>
            <DataTemplate>
                <Label Text="{Binding Filter, StringFormat='Your filter term of {0} did not match any records.'}"
                       Margin="10,25,10,10"
                       FontAttributes="Bold"
                       FontSize="18"
                       HorizontalOptions="Fill"
                       HorizontalTextAlignment="Center" />
            </DataTemplate>
        </CollectionView.EmptyViewTemplate>
    </CollectionView>
</StackLayout>

O código C# equivalente é:The equivalent C# code is:

SearchBar searchBar = new SearchBar { ... };
CollectionView collectionView = new CollectionView
{
    EmptyView = new FilterData { Filter = searchBar.Text },
    EmptyViewTemplate = new DataTemplate(() =>
    {
        return new Label { ... };
    })
};

O FilterData tipo define uma Filter propriedade e um correspondente BindableProperty :The FilterData type defines a Filter property, and a corresponding BindableProperty:

public class FilterData : BindableObject
{
    public static readonly BindableProperty FilterProperty = BindableProperty.Create(nameof(Filter), typeof(string), typeof(FilterData), null);

    public string Filter
    {
        get { return (string)GetValue(FilterProperty); }
        set { SetValue(FilterProperty, value); }
    }
}

O EmptyView estiver definida como um FilterData objeto e o Filter associa dados de propriedade para o SearchBar.Text propriedade.The EmptyView property is set to a FilterData object, and the Filter property data binds to the SearchBar.Text property. Quando o SearchBar executa o FilterCommand, a coleção exibida pelo CollectionView é filtrado para o termo de pesquisa são armazenados no Filter propriedade.When the SearchBar executes the FilterCommand, the collection displayed by the CollectionView is filtered for the search term stored in the Filter property. Se a operação de filtragem não produz nenhum dado, o Label definidos no DataTemplate , que é definido como o EmptyViewTemplate é de valor da propriedade, exibido:If the filtering operation yields no data, the Label defined in the DataTemplate, that's set as the EmptyViewTemplate property value, is displayed:

Captura de tela de uma lista vertical de CollectionView com um modelo de exibição vazio, no iOS e AndroidScreenshot of a CollectionView vertical list with an empty view template, on iOS and Android

Observação

Ao exibir um tipo de modelo personalizado quando dados não estiverem disponíveis, o EmptyViewTemplate propriedade pode ser definida como uma exibição que contém vários modos de exibição filho.When displaying a templated custom type when data is unavailable, the EmptyViewTemplate property can be set to a view that contains multiple child views.

Escolha um EmptyView em tempo de execuçãoChoose an EmptyView at runtime

Modos de exibição que serão exibidos como uma EmptyView quando dados não estiverem disponíveis, pode ser definida como ContentView objetos em um ResourceDictionary .Views that will be displayed as an EmptyView when data is unavailable, can be defined as ContentView objects in a ResourceDictionary. O EmptyView propriedade, em seguida, pode ser definida para um determinado ContentView, com base em alguma lógica de negócios, em tempo de execução.The EmptyView property can then be set to a specific ContentView, based on some business logic, at runtime. O exemplo XAML a seguir mostra um exemplo desse cenário:The following XAML example shows an example of this scenario:

<?xml version="1.0" encoding="UTF-8"?>
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             x:Class="CollectionViewDemos.Views.EmptyViewSwapPage"
             Title="EmptyView (swap)">
    <ContentPage.Resources>
        <ContentView x:Key="BasicEmptyView">
            <StackLayout>
                <Label Text="No items to display."
                       Margin="10,25,10,10"
                       FontAttributes="Bold"
                       FontSize="18"
                       HorizontalOptions="Fill"
                       HorizontalTextAlignment="Center" />
            </StackLayout>
        </ContentView>
        <ContentView x:Key="AdvancedEmptyView">
            <StackLayout>
                <Label Text="No results matched your filter."
                       Margin="10,25,10,10"
                       FontAttributes="Bold"
                       FontSize="18"
                       HorizontalOptions="Fill"
                       HorizontalTextAlignment="Center" />
                <Label Text="Try a broader filter?"
                       FontAttributes="Italic"
                       FontSize="12"
                       HorizontalOptions="Fill"
                       HorizontalTextAlignment="Center" />
            </StackLayout>
        </ContentView>
    </ContentPage.Resources>

    <StackLayout Margin="20">
        <SearchBar x:Name="searchBar"
                   SearchCommand="{Binding FilterCommand}"
                   SearchCommandParameter="{Binding Source={x:Reference searchBar}, Path=Text}"
                   Placeholder="Filter" />
        <StackLayout Orientation="Horizontal">
            <Label Text="Toggle EmptyViews" />
            <Switch Toggled="OnEmptyViewSwitchToggled" />
        </StackLayout>
        <CollectionView x:Name="collectionView"
                        ItemsSource="{Binding Monkeys}">
            <CollectionView.ItemTemplate>
                <DataTemplate>
                    ...
                </DataTemplate>
            </CollectionView.ItemTemplate>
        </CollectionView>
    </StackLayout>
</ContentPage>

Esse XAML define dois ContentView objetos no nível da página ResourceDictionary , com o Switch objeto controlando quais ContentView objeto será definido como o EmptyView valor da propriedade.This XAML defines two ContentView objects in the page-level ResourceDictionary, with the Switch object controlling which ContentView object will be set as the EmptyView property value. Quando o Switch é alternado, o OnEmptyViewSwitchToggled manipulador de eventos executa o ToggleEmptyView método:When the Switch is toggled, the OnEmptyViewSwitchToggled event handler executes the ToggleEmptyView method:

void ToggleEmptyView(bool isToggled)
{
    collectionView.EmptyView = isToggled ? Resources["BasicEmptyView"] : Resources["AdvancedEmptyView"];
}

O ToggleEmptyView método define o EmptyView propriedade do collectionView objeto para um dos dois ContentView objetos armazenados na ResourceDictionary , com base no valor da Switch.IsToggled propriedade.The ToggleEmptyView method sets the EmptyView property of the collectionView object to one of the two ContentView objects stored in the ResourceDictionary, based on the value of the Switch.IsToggled property. Quando o SearchBar executa o FilterCommand, a coleção exibida pelo CollectionView é filtrado para o termo de pesquisa são armazenados no SearchBar.Text propriedade.When the SearchBar executes the FilterCommand, the collection displayed by the CollectionView is filtered for the search term stored in the SearchBar.Text property. Se a operação de filtragem não produz nenhum dado, o ContentView objeto definido como o EmptyView propriedade é exibida:If the filtering operation yields no data, the ContentView object set as the EmptyView property is displayed:

Captura de tela de uma lista vertical de CollectionView com exibições vazias trocadas, no iOS e AndroidScreenshot of a CollectionView vertical list with swapped empty views, on iOS and Android

Para obter mais informações sobre dicionários de recursos, consulte dicionários de recursos do xamarin. Forms.For more information about resource dictionaries, see Xamarin.Forms Resource Dictionaries.

Escolha um EmptyViewTemplate em tempo de execuçãoChoose an EmptyViewTemplate at runtime

A aparência do EmptyView pode ser escolhido no tempo de execução, com base em seu valor, definindo o CollectionView.EmptyViewTemplate propriedade para um DataTemplateSelector objeto:The appearance of the EmptyView can be chosen at runtime, based on its value, by setting the CollectionView.EmptyViewTemplate property to a DataTemplateSelector object:

<ContentPage ...
             xmlns:controls="clr-namespace:CollectionViewDemos.Controls">
    <ContentPage.Resources>
        <DataTemplate x:Key="AdvancedTemplate">
            ...
        </DataTemplate>

        <DataTemplate x:Key="BasicTemplate">
            ...
        </DataTemplate>

        <controls:SearchTermDataTemplateSelector x:Key="SearchSelector"
                                                 DefaultTemplate="{StaticResource AdvancedTemplate}"
                                                 OtherTemplate="{StaticResource BasicTemplate}" />
    </ContentPage.Resources>

    <StackLayout Margin="20">
        <SearchBar x:Name="searchBar"
                   SearchCommand="{Binding FilterCommand}"
                   SearchCommandParameter="{Binding Source={x:Reference searchBar}, Path=Text}"
                   Placeholder="Filter" />
        <CollectionView ItemsSource="{Binding Monkeys}"
                        EmptyView="{Binding Source={x:Reference searchBar}, Path=Text}"
                        EmptyViewTemplate="{StaticResource SearchSelector}" />
    </StackLayout>
</ContentPage>

O código C# equivalente é:The equivalent C# code is:

SearchBar searchBar = new SearchBar { ... };
CollectionView collectionView = new CollectionView
{
    EmptyView = searchBar.Text,
    EmptyViewTemplate = new SearchTermDataTemplateSelector { ... }
};
collectionView.SetBinding(ItemsView.ItemsSourceProperty, "Monkeys");

O EmptyView estiver definida como o SearchBar.Text propriedade e o EmptyViewTemplate estiver definida como um SearchTermDataTemplateSelector objeto.The EmptyView property is set to the SearchBar.Text property, and the EmptyViewTemplate property is set to a SearchTermDataTemplateSelector object.

Quando o SearchBar executa o FilterCommand, a coleção exibida pelo CollectionView é filtrado para o termo de pesquisa são armazenados no SearchBar.Text propriedade.When the SearchBar executes the FilterCommand, the collection displayed by the CollectionView is filtered for the search term stored in the SearchBar.Text property. Se a operação de filtragem não produz nenhum dado, o DataTemplate escolhido pelo SearchTermDataTemplateSelector objeto é definido como o EmptyViewTemplate propriedade e exibido.If the filtering operation yields no data, the DataTemplate chosen by the SearchTermDataTemplateSelector object is set as the EmptyViewTemplate property and displayed.

A exemplo a seguir mostra o SearchTermDataTemplateSelector classe:The following example shows the SearchTermDataTemplateSelector class:

public class SearchTermDataTemplateSelector : DataTemplateSelector
{
    public DataTemplate DefaultTemplate { get; set; }
    public DataTemplate OtherTemplate { get; set; }

    protected override DataTemplate OnSelectTemplate(object item, BindableObject container)
    {
        string query = (string)item;
        return query.ToLower().Equals("xamarin") ? OtherTemplate : DefaultTemplate;
    }
}

O SearchTermTemplateSelector classe define DefaultTemplate e OtherTemplate DataTemplate propriedades que são definidas para modelos de dados diferentes.The SearchTermTemplateSelector class defines DefaultTemplate and OtherTemplate DataTemplate properties that are set to different data templates. O OnSelectTemplate substituir retorna DefaultTemplate, que exibe uma mensagem para o usuário, quando a consulta de pesquisa não for igual a "xamarin".The OnSelectTemplate override returns DefaultTemplate, which displays a message to the user, when the search query isn't equal to "xamarin". Quando a consulta de pesquisa é igual a "xamarin", o OnSelectTemplate substituir retorna OtherTemplate, que exibe uma mensagem básica para o usuário:When the search query is equal to "xamarin", the OnSelectTemplate override returns OtherTemplate, which displays a basic message to the user:

Captura de tela da seleção de modelo CollectionView runtime modo de exibição vazio, no iOS e AndroidScreenshot of a CollectionView runtime empty view template selection, on iOS and Android

Para obter mais informações sobre os seletores de modelo de dados, consulte criar um xamarin. Forms DataTemplateSelector.For more information about data template selectors, see Create a Xamarin.Forms DataTemplateSelector.