Contrôles d’éléments XAML ; liaison à une collection C++/WinRT

  • Article

Une collection qui peut être efficacement liée à un contrôle d’éléments XAML est appelée collection observable. Ce concept est basé sur le modèle de conception logicielle appelé modèle observateur. Cette rubrique montre comment implémenter des collections observables en C++/WinRT et y lier des contrôles d’éléments XAML (pour des informations de référence, consultez Liaison de données.

Si vous souhaitez suivre cette rubrique, nous vous recommandons de tout d’abord créer le projet décrit dans la section Contrôles XAML ; liaison à une propriété C++/WinRT. Cette rubrique ajoute plus de code à ce projet et complète les concepts abordés.

Important

Pour obtenir les principaux concepts et termes facilitant votre compréhension pour utiliser et créer des classes runtime avec C++/WinRT, voir Utiliser des API avec C++/WinRT et Créer des API avec C++/WinRT.

Que signifie « observable » pour une collection ?

Si une classe runtime qui représente une collection choisit de déclencher l’événement IObservableVector<T>: : VectorChanged chaque fois qu’un élément lui est ajouté ou retiré, alors la classe runtime est une collection observable. Un contrôle d’éléments XAML peut lier et gérer ces événements en récupérant la collection mise à jour et en se mettant à jour lui-même pour afficher les éléments actuels.

Notes

Pour plus d’informations sur l’installation et l’utilisation de l’extension VSIX (Visual Studio Extension) C++/WinRT et du package NuGet (qui fournissent ensemble la prise en charge des modèles et des builds de projet), consultez Prise en charge de Visual Studio pour C++/WinRT.

Ajouter une collection BookSkus à BookstoreViewModel

Dans Contrôles XAML ; liaison à une propriété C++/WinRT, nous avons ajouté une propriété de type BookSku à notre modèle d’affichage principal. Dans cette étape, nous allons utiliser le modèle de fonction d’usine winrt::single_threaded_observable_vector pour implémenter une collection observable de BookSku sur le même modèle d’affichage.

Déclarez une nouvelle propriété dans BookstoreViewModel.idl.

// BookstoreViewModel.idl
...
runtimeclass BookstoreViewModel
{
    BookSku BookSku{ get; };
    Windows.Foundation.Collections.IObservableVector<BookSku> BookSkus{ get; };
}
...

Notes

Dans le listing MIDL 3.0 ci-dessus, notez que le type de la propriété BookSkus est IObservableVector de BookSku. Dans la section suivante de cette rubrique, nous allons lier la source des éléments d’un ListBox à BookSkus. Une zone de liste est un contrôle d’éléments. Pour définir correctement la propriété ItemsControl.ItemsSource, vous devez lui affecter une valeur de type IObservableVector ou IVector, ou d’un type d’interopérabilité tel que IBindableObservableVector.

Avertissement

Le code présenté dans cette rubrique s’applique à C++/WinRT version 2.0.190530.8 ou ultérieure. Si vous utilisez une version antérieure, vous devez légèrement adapter le code affiché. Dans le listing MIDL 3.0 ci-dessus, remplacez la propriété BookSkus par le type IObservableVector de IInspectable. Ensuite, utilisez également IInspectable (à la place de BookSku) dans votre implémentation.

Enregistrez et lancez la génération. Copiez les stubs accesseur de BookstoreViewModel.h et BookstoreViewModel.cpp dans le dossier \Bookstore\Bookstore\Generated Files\sources (pour plus d’informations, consultez la rubrique précédente, Contrôles XAML ; liaison à une propriété C++/WinRT). Implémentez ces stubs accesseur comme suit.

// BookstoreViewModel.h
...
struct BookstoreViewModel : BookstoreViewModelT<BookstoreViewModel>
{
    BookstoreViewModel();

    Bookstore::BookSku BookSku();

    Windows::Foundation::Collections::IObservableVector<Bookstore::BookSku> BookSkus();

private:
    Bookstore::BookSku m_bookSku{ nullptr };
    Windows::Foundation::Collections::IObservableVector<Bookstore::BookSku> m_bookSkus;
};
...

// BookstoreViewModel.cpp
...
BookstoreViewModel::BookstoreViewModel()
{
    m_bookSku = winrt::make<Bookstore::implementation::BookSku>(L"Atticus");
    m_bookSkus = winrt::single_threaded_observable_vector<Bookstore::BookSku>();
    m_bookSkus.Append(m_bookSku);
}

Bookstore::BookSku BookstoreViewModel::BookSku()
{
    return m_bookSku;
}

Windows::Foundation::Collections::IObservableVector<Bookstore::BookSku> BookstoreViewModel::BookSkus()
{
    return m_bookSkus;
}
...

Lier un élément ListBox à la propriété BookSkus

Ouvrez MainPage.xaml, qui contient le balisage XAML pour notre page d’interface utilisateur principale. Ajoutez le balisage suivant dans le même StackPanel que Button.

<ListBox ItemsSource="{x:Bind MainViewModel.BookSkus}">
    <ItemsControl.ItemTemplate>
        <DataTemplate x:DataType="local:BookSku">
            <TextBlock Text="{x:Bind Title, Mode=OneWay}"/>
        </DataTemplate>
    </ItemsControl.ItemTemplate>
</ListBox>

Dans MainPage.cpp, ajoutez une ligne de code au gestionnaire d’événements Click pour ajouter un livre à la collection.

// MainPage.cpp
...
void MainPage::ClickHandler(IInspectable const&, RoutedEventArgs const&)
{
    MainViewModel().BookSku().Title(L"To Kill a Mockingbird");
    MainViewModel().BookSkus().Append(winrt::make<Bookstore::implementation::BookSku>(L"Moby Dick"));
}
...

Lancez à présent le processus de génération et exécutez le projet. Cliquez sur le bouton pour exécuter le gestionnaire d’événements Click. Nous avons vu que l’implémentation de Append déclenche un événement pour informer l’interface utilisateur que la collection a changé ; l’élément ListBox interroge de nouveau la collection pour mettre à jour sa propre valeur Items. Exactement comme précédemment, le titre de l’un des livres change ; et ce changement de titre est reflété à la fois sur le bouton et dans la zone de liste.

API importantes