.NET MAUIのCollectionViewを試してみる

普段のお仕事に役立つ普遍的なプログラミングTIPSや、業界で注目度が高い最新情報をお届けする「編集部ピックアップ」。
今回は .NET MAUIでデータを一覧表示するためのコントロール「CollectionView」を実装する方法ついてお届けします。

本記事では .NET MAUIアプリケーション開発向けに標準で用意されているコントロールの1つで、データを一覧表示するコントロール「CollectionView」の実装方法を確認してみます。

.NET MAUIとは?

.NET MAUI(.NET Multi-Platform App UI)」は、以前のXamarin.Formsから進化した後継のUIフレームワークです。C#とXAMLを利用した1つのプロジェクト(同一のコードベース)から、ネイティブのモバイルアプリ(iOS、Android)とデスクトップアプリ(Windows、macOS)の開発ができます。

.NET MAUIで利用できるコントロールは?

.NET MAUIで利用可能なUIコントロールは以下のページにリストアップされています。

.NET MAUI ビューは、ラベル、ボタン、スライダーなどの UI オブジェクトであり、他の環境では一般的に コントロール や ウィジェット と呼ばれます。

https://learn.microsoft.com/ja-jp/dotnet/maui/user-interface/controls/#views

.NET MAUIで利用できるコントロールのサンプルは?

以下のGitHubリポジトリから入手できます。

このリポジトリに含まれる「Control Gallery」で各コントロールの動作を確認することが可能です。

.NET MAUI 
 Demos - Control Gallery

このControl Galleryには、今回紹介するCollectionViewのサンプルも含まれていて動作を確認することができます。

.NET MAUI Control Gallery

また、「CollectionViewDemos」ではCollectionViewのいろいろな機能を確認することができます。

.NET MAUI Demos - CollectionViewDemos

なお、公式以外のサンプルをはじめとするリソースは以下のGitHubリポジトリにまとめられており、こちらも参考になります。

.NET MAUIアプリケーションにCollectionViewを実装してみる

では実際に .NET MAUIアプリケーションにCollectionViewを追加してみます。

.NET MAUIアプリケーションの作成

まず、Visual Studio 2022を起動してプロジェクトテンプレート「.NET MAUI アプリ」を選択し、.NET MAUIアプリケーション「MauiApp1」を作成します。

.NET MAUIアプリケーションの作成
.NET MAUIアプリケーションの作成

CollectionViewの追加

MainPage.xamlに追加されているScrollViewVerticalStackLayoutImageLabelButtonを削除してGridCollectionViewを追加します。

<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             x:Class="MauiApp1.MainPage">

    <Grid>
        <CollectionView></CollectionView>
    </Grid>

</ContentPage>

なお、Gridの代わりにStackLayoutVerticalStackLayoutを使用するとCollectionViewでデータを一覧表示した際にスクロールが動作しないと以下で報告されていますが、これは .NET MAUIでの制限事項のようなので注意しておくとよさそうです。

先ほど紹介した公式のデモでもGridではなくStackLayoutVerticalStackLayoutを使用しているので、CollectionViewがスクロールしない状態になっているようです。今後修正されることを期待したいですね。

データソースの追加

CollectionViewDemos」 を参考にCollectionViewで表示するデータを作成します。プロジェクトにModelsフォルダを追加してMonkeyクラスを追加します。

public class Monkey
{
    public string Name { get; set; }
    public string Location { get; set; }
    public string Details { get; set; }
    public string ImageUrl { get; set; }
}

さらにプロジェクトにViewModelsフォルダを追加してMonkeysViewModelクラスを追加します。

public class MonkeysViewModel
{
    public ObservableCollection<Monkey> Monkeys { get; private set; } = new ObservableCollection<Monkey>();

    public MonkeysViewModel()
    {
        CreateMonkeyCollection();
    }

    void CreateMonkeyCollection()
    {
        Monkeys.Add(new Monkey
        {
            Name = "Baboon",
            Location = "Africa & Asia",
            Details = "Baboons are African and Arabian Old World monkeys belonging to the genus Papio, part of the subfamily Cercopithecinae.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/f/fc/Papio_anubis_%28Serengeti%2C_2009%29.jpg/200px-Papio_anubis_%28Serengeti%2C_2009%29.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Capuchin Monkey",
            Location = "Central & South America",
            Details = "The capuchin monkeys are New World monkeys of the subfamily Cebinae. Prior to 2011, the subfamily contained only a single genus, Cebus.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/4/40/Capuchin_Costa_Rica.jpg/200px-Capuchin_Costa_Rica.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Blue Monkey",
            Location = "Central and East Africa",
            Details = "The blue monkey or diademed monkey is a species of Old World monkey native to Central and East Africa, ranging from the upper Congo River basin east to the East African Rift and south to northern Angola and Zambia",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/8/83/BlueMonkey.jpg/220px-BlueMonkey.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Squirrel Monkey",
            Location = "Central & South America",
            Details = "The squirrel monkeys are the New World monkeys of the genus Saimiri. They are the only genus in the subfamily Saimirinae. The name of the genus Saimiri is of Tupi origin, and was also used as an English name by early researchers.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/2/20/Saimiri_sciureus-1_Luc_Viatour.jpg/220px-Saimiri_sciureus-1_Luc_Viatour.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Golden Lion Tamarin",
            Location = "Brazil",
            Details = "The golden lion tamarin also known as the golden marmoset, is a small New World monkey of the family Callitrichidae.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/8/87/Golden_lion_tamarin_portrait3.jpg/220px-Golden_lion_tamarin_portrait3.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Howler Monkey",
            Location = "South America",
            Details = "Howler monkeys are among the largest of the New World monkeys. Fifteen species are currently recognised. Previously classified in the family Cebidae, they are now placed in the family Atelidae.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/0/0d/Alouatta_guariba.jpg/200px-Alouatta_guariba.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Japanese Macaque",
            Location = "Japan",
            Details = "The Japanese macaque, is a terrestrial Old World monkey species native to Japan. They are also sometimes known as the snow monkey because they live in areas where snow covers the ground for months each",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/c/c1/Macaca_fuscata_fuscata1.jpg/220px-Macaca_fuscata_fuscata1.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Mandrill",
            Location = "Southern Cameroon, Gabon, Equatorial Guinea, and Congo",
            Details = "The mandrill is a primate of the Old World monkey family, closely related to the baboons and even more closely to the drill. It is found in southern Cameroon, Gabon, Equatorial Guinea, and Congo.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/7/75/Mandrill_at_san_francisco_zoo.jpg/220px-Mandrill_at_san_francisco_zoo.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Proboscis Monkey",
            Location = "Borneo",
            Details = "The proboscis monkey or long-nosed monkey, known as the bekantan in Malay, is a reddish-brown arboreal Old World monkey that is endemic to the south-east Asian island of Borneo.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e5/Proboscis_Monkey_in_Borneo.jpg/250px-Proboscis_Monkey_in_Borneo.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Red-shanked Douc",
            Location = "Vietnam, Laos",
            Details = "The red-shanked douc is a species of Old World monkey, among the most colourful of all primates. This monkey is sometimes called the \"costumed ape\" for its extravagant appearance. From its knees to its ankles it sports maroon-red \"stockings\", and it appears to wear white forearm length gloves. Its attire is finished with black hands and feet. The golden face is framed by a white ruff, which is considerably fluffier in males. The eyelids are a soft powder blue. The tail is white with a triangle of white hair at the base. Males of all ages have a white spot on both sides of the corners of the rump patch, and red and white genitals.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/9/9f/Portrait_of_a_Douc.jpg/159px-Portrait_of_a_Douc.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Gray-shanked Douc",
            Location = "Vietnam",
            Details = "The gray-shanked douc langur is a douc species native to the Vietnamese provinces of Quảng Nam, Quảng Ngãi, Bình Định, Kon Tum, and Gia Lai. The total population is estimated at 550 to 700 individuals. In 2016, Dr Benjamin Rawson, Country Director of Fauna & Flora International - Vietnam Programme, announced a discovery of an additional population of more than 500 individuals found in Central Vietnam, bringing the total population up to approximately 1000 individuals.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/Cuc.Phuong.Primate.Rehab.center.jpg/320px-Cuc.Phuong.Primate.Rehab.center.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Golden Snub-nosed Monkey",
            Location = "China",
            Details = "The golden snub-nosed monkey is an Old World monkey in the Colobinae subfamily. It is endemic to a small area in temperate, mountainous forests of central and Southwest China. They inhabit these mountainous forests of Southwestern China at elevations of 1,500-3,400 m above sea level. The Chinese name is Sichuan golden hair monkey. It is also widely referred to as the Sichuan snub-nosed monkey. Of the three species of snub-nosed monkeys in China, the golden snub-nosed monkey is the most widely distributed throughout China.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/c/c8/Golden_Snub-nosed_Monkeys%2C_Qinling_Mountains_-_China.jpg/165px-Golden_Snub-nosed_Monkeys%2C_Qinling_Mountains_-_China.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Black Snub-nosed Monkey",
            Location = "China",
            Details = "The black snub-nosed monkey, also known as the Yunnan snub-nosed monkey, is an endangered species of primate in the family Cercopithecidae. It is endemic to China, where it is known to the locals as the Yunnan golden hair monkey and the black golden hair monkey. It is threatened by habitat loss. It was named after Bishop Félix Biet.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/5/59/RhinopitecusBieti.jpg/320px-RhinopitecusBieti.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Tonkin Snub-nosed Monkey",
            Location = "Vietnam",
            Details = "The Tonkin snub-nosed monkey or Dollman's snub-nosed monkey is a slender-bodied arboreal Old World monkey, endemic to northern Vietnam. It is a black and white monkey with a pink nose and lips and blue patches round the eyes. It is found at altitudes of 200 to 1,200 m (700 to 3,900 ft) on fragmentary patches of forest on craggy limestone areas. First described in 1912, the monkey was rediscovered in 1990 but is exceedingly rare. In 2008, fewer than 250 individuals were thought to exist, and the species was the subject of intense conservation effort. The main threats faced by these monkeys is habitat loss and hunting, and the International Union for Conservation of Nature has rated the species as \"critically endangered\".",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/9/9c/Tonkin_snub-nosed_monkeys_%28Rhinopithecus_avunculus%29.jpg/320px-Tonkin_snub-nosed_monkeys_%28Rhinopithecus_avunculus%29.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Thomas's Langur",
            Location = "Indonesia",
            Details = "Thomas's langur is a species of primate in the family Cercopithecidae. It is endemic to North Sumatra, Indonesia. Its natural habitat is subtropical or tropical dry forests. It is threatened by habitat loss. Its native names are reungkah in Acehnese and kedih in Alas.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/3/31/Thomas%27s_langur_Presbytis_thomasi.jpg/142px-Thomas%27s_langur_Presbytis_thomasi.jpg"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Purple-faced Langur",
            Location = "Sri Lanka",
            Details = "The purple-faced langur, also known as the purple-faced leaf monkey, is a species of Old World monkey that is endemic to Sri Lanka. The animal is a long-tailed arboreal species, identified by a mostly brown appearance, dark face (with paler lower face) and a very shy nature. The species was once highly prevalent, found in suburban Colombo and the \"wet zone\" villages (areas with high temperatures and high humidity throughout the year, whilst rain deluges occur during the monsoon seasons), but rapid urbanization has led to a significant decrease in the population level of the monkeys.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/0/02/Semnopithèque_blanchâtre_mâle.JPG/192px-Semnopithèque_blanchâtre_mâle.JPG"
        });

        Monkeys.Add(new Monkey
        {
            Name = "Gelada",
            Location = "Ethiopia",
            Details = "The gelada, sometimes called the bleeding-heart monkey or the gelada baboon, is a species of Old World monkey found only in the Ethiopian Highlands, with large populations in the Semien Mountains. Theropithecus is derived from the Greek root words for \"beast-ape.\" Like its close relatives the baboons, it is largely terrestrial, spending much of its time foraging in grasslands.",
            ImageUrl = "https://upload.wikimedia.org/wikipedia/commons/thumb/1/13/Gelada-Pavian.jpg/320px-Gelada-Pavian.jpg"
        });
    }
}

CollectionViewにデータを設定する

以下のドキュメントを参考にデータを設定します。

まず、CollectionViewのItemSourceにデータソースを設定します。

public MainPage()
{
    InitializeComponent();

		BindingContext = new MonkeysViewModel();
}
<CollectionView ItemsSource="{Binding Monkeys}" >
    
</CollectionView>

さらにItemTemplateにデータテンプレートを設定して、データを表示する際の外観を設定します。データテンプレート内のImageLabelにはそれぞれMonkeysコレクションの各データを設定しています。

<CollectionView ItemsSource="{Binding Monkeys}" >
    <CollectionView.ItemTemplate>
        <DataTemplate>
            <Grid Padding="10" 
                  RowDefinitions="Auto, Auto, Auto" 
                  ColumnDefinitions="Auto, *" 
                  RowSpacing="5"
                  ColumnSpacing="5">
                <Image Grid.RowSpan="3" 
                       Source="{Binding ImageUrl}" 
                       Aspect="AspectFill"
                       HeightRequest="80" 
                       WidthRequest="80" />
                <Label Grid.Column="1" 
                       Text="{Binding Name}" 
                       FontAttributes="Bold" />
                <Label Grid.Row="1"
                       Grid.Column="1" 
                       Text="{Binding Location}"
                       FontAttributes="Italic" 
                       VerticalOptions="Start" />
                <Label Grid.Row="2"
                       Grid.Column="1" 
                       Text="{Binding Details}"
                       FontAttributes="Italic" 
                       VerticalOptions="Start"
                       LineBreakMode="WordWrap"
                       MaxLines="2" />
            </Grid>
        </DataTemplate>
    </CollectionView.ItemTemplate>
</CollectionView>

ビルドして実行してみる

ここまででCollectionViewを追加した .NET MAUIアプリケーションを作成できたので、ビルドして実行してみます。以下のようにCollectionViewにデータソースから追加したデータが表示されれば完成です。

ビルドして実行してみる

なお、Windows用のアプリケーションのみで発生するようですが、ネットワーク上にある画像が正しく表示されない現象が確認できます。画像を表示する場合はローカルのリソースとして画像ファイルを用意しておいて設定する方法がよさそうです。

AndroidとiOSのエミュレーターに配置した場合も同じくCollectionViewにデータが表示できます。

ビルドして実行してみる
ビルドして実行してみる

さいごに

今回はCollectionViewの追加方法を紹介しました。以前にXamarin.FormsでCollectionViewを使用していた方はとくに違和感なく .NET MAUIのCollectionViewも実装できそうだと思いました。

\  この記事をシェアする  /