連載
» 2016年12月28日 05時00分 UPDATE

.NET TIPS:Xamarin.Forms:ScrollViewコントロールで画面をスクロールさせるには?

ScrollViewコントロールを使うことで、画面サイズには収まりきらないUI要素をスクロールして表示する方法を解説する。

[山本康彦,BluewaterSoft/Microsoft MVP for Windows Development]
「.NET TIPS」のインデックス

連載目次

対象:Visual Studio 2015以降


 Xamarin.FormsでUIコントロールを配置するとき、画面に収まりきらないこともあるだろう。そんなとき、ScrollViewコントロール(Xamarin.Forms名前空間)を使ってスクロール可能にできる。

 本稿では、ScrollViewコントロールの記述方法と、コードビハインドからスクロールさせる方法を解説する*1

*1 本稿で使用したXamarin.Formsのバージョン

Xamarin 4.2.1.60 (47830f6)/Xamarin.Forms 2.2.0.45


ScrollViewコントロールの使用例

 ScrollViewコントロールの使用例を次の画像に示す。中央部分(背景色が黄色の部分)が、ScrollViewコントロールだ。その中にStackLayoutコントロールを置き、さらにその中に複数のLabelコントロールを配置している。このデバイスの場合(Windows 10のデスクトップ)、ScrollViewコントロール上にマウスをホバーさせると、スクロールバーが表示される。

 なお、ScrollViewコントロールの中にスクロール可能なコントロール(ScrollViewコントロール/ListViewコントロール/WebViewコントロールなど)を配置すると、スクロールできなくなるので注意しよう*2

ScrollViewコントロールの使用例(Windows 10) ScrollViewコントロールの使用例(Windows 10)
画面の中央部分(背景色が黄色の部分)が、ScrollViewコントロールだ。
Windows 10のデスクトップでは、ScrollViewコントロール上にマウスをホバーさせると、このようにスクロールバーが表示される(ScrollViewコントロールの右端と下端)。
下端にあるボタンをタップ/クリックすると、Label07まで自動的にスクロールする。そのコードは後ほど紹介する。

*2 これを解決するには、中に配置するスクロール可能なUIコントロールでNestedScrollingEnabledプロパティをtrueに設定すればよいようだ。

参照:「Xamarin.Forms(Android)ScrollViewの中にあるListViewをスクロールさせる - Qiita


ScrollViewコントロールの記述方法

 ScrollViewコントロールには、UIコントロールを1個だけ格納できる。複数のUIコントロールを配置するには、ScrollViewコントロールにGridコントロールやStackLayoutコントロールなどを置いてから、その中に配置する。

 ScrollViewコントロールに特徴的なプロパティとして、Orientationプロパティがある。Orientationプロパティには、次に示す3種類の値のいずれかを設定できる(冒頭の画像の例では「Both」を指定してある)。

  • Vertical: 縦にスクロールできる(既定)
  • Horizontal: 横にスクロールできる
  • Both: 縦/横どちらにもスクロールできる

 その他に、次に示す読み取り専用のプロパティもある。

  • ContentSizeプロパティ: 格納しているUIコントロールのサイズ(スクロール可能な状態では、ScrollViewコントロールのサイズよりもContentSizeプロパティの示すサイズの方が大きい)
  • ScrollXプロパティ/ScrollYプロパティ: スクロール位置(epx単位)

コードビハインドからスクロールさせるには?

 特定の位置までコードビハインドからスクロールさせるには、ScrollViewコントロールのScrollToAsyncメソッドを使えばよい。このメソッドには、2通りのオーバーロードがある。

スクロール位置を指定してスクロールする:

 ここで、引数のxとyは、スクロールし終わったときにScrollViewコントロールの左上隅に来る座標だ(epx単位)。また、3番目の引数animatedにtrueを与えると、スクロール中にアニメーションする。

UIコントロールを指定してスクロールする:

 こちらは、第1引数に指定したUIコントロールが見えるようにスクロールさせるメソッドだ。第2引数positionで、スクロールし終わったときに指定したUIコントロールがどのように見えるかを指定する(次の4つのいずれか)。

  • Start: 指定したUIコントロールが上端(または左端)に来る
  • End: 指定したUIコントロールが下端(または右端)に来る
  • Center: 指定したUIコントロールが中央に来る
  • MakeVisible: 指定したUIコントロールが見えるようになるまでスクロールする

 また、3番目の引数animatedの意味は前のオーバーロードと同じだ。

 なお、ScrollToAsyncメソッドはどちらのオーバーロードも非同期で実行される。スクロールが終わってから実行したい処理を書くときには、async/awaitキーワードが必要だ。

実際の例

 実際の例として、冒頭の画像に示したアプリのコードを紹介しよう。

 ソリューションを新しく作るときに[Blank Xaml App (Xamarin.Forms Portable)]を選ぶ。以下ではソリューション名(=PCLプロジェクトの名前)は「dotNetTips1171」としている。

 そうしたら、PCLプロジェクトにあるMainPage.xamlファイルの内容を次のように変更する。

<?xml version="1.0" encoding="utf-8" ?>
<ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:local="clr-namespace:dotNetTips1171"
             x:Class="dotNetTips1171.MainPage">
  <ContentPage.Resources>
    <ResourceDictionary>
      <Style TargetType="ContentPage">
        <Setter Property="Padding">
          <OnPlatform x:TypeArguments="Thickness" iOS="0,20,0,0" />
        </Setter>
      </Style>
      <Style TargetType="Label">
        <Setter Property="HeightRequest" Value="100" />
        <Setter Property="WidthRequest" Value="600" />
        <Setter Property="FontSize" Value="Large" />
        <Setter Property="TextColor" Value="White" />
        <Setter Property="BackgroundColor" Value="Accent" />
        <Setter Property="HorizontalTextAlignment" Value="Center" />
        <Setter Property="VerticalTextAlignment" Value="Center" />
      </Style>
      <Style TargetType="Button">
        <Setter Property="TextColor" Value="White" />
        <Setter Property="BackgroundColor" Value="Accent" />
        <Setter Property="HeightRequest" Value="75" />
        <Setter Property="WidthRequest" Value="250" />
        <Setter Property="Margin" Value="0,5,0,15" />
        <Setter Property="HorizontalOptions" Value="Center" />
      </Style>
    </ResourceDictionary>
  </ContentPage.Resources>

  <StackLayout>
    <Label Text="ScrollView サンプル" TextColor="Accent"
           BackgroundColor="Transparent" />
    <ScrollView x:Name="ScrollView1" BackgroundColor="Yellow"
                  Orientation="Both">
      <StackLayout Spacing="10" Padding="10">
        <Label Text="Label01" />
        ……省略(Label02〜Label06)……
        <Label Text="Label07" x:Name="Label07" />
        ……省略(Label08〜Label11)……
        <Label Text="Label12" />
      </StackLayout>
    </ScrollView>
    <Button Clicked="Button_Clicked" Text="Label07までスクロール" />
  </StackLayout>
</ContentPage>

ScrollViewコントロール内の使用例(XAML)
ここではScrollViewコントロールのOrientationプロパティに「Both」と指定した。これにより、縦だけでなく横にもスクロールできる(省略時は縦スクロールのみ)。
なお、ScrollViewコントロールに「ScrollView1」という名前を、7つ目のLabelコントロールに「Label07」という名前を付けてある。また、ButtonコントロールのClickedイベントには「Button_Clicked」という名前のメソッドを指定してある(まだコードビハインドにメソッドを書いていないので、このままではコンパイルできない)。これらは、次に解説するコードビハインドで使用する。

 次に、コードビハインドにイベントハンドラーを追加しよう。PCLプロジェクトにあるMainPage.xaml.csファイルの内容を次のように変更する。

using System;
using Xamarin.Forms;

namespace dotNetTips1171
{
  public partial class MainPage : ContentPage
  {
    public MainPage()
    {
      InitializeComponent();
    }

    private void Button_Clicked(object sender, EventArgs e)
    {
      ScrollView1.ScrollToAsync(Label07, ScrollToPosition.Center, true);
    }
  }
}

コードビハインドからスクロールさせる(C#)
MainPage.xaml.csファイルに「Button_Clicked」メソッドを追加した。
ボタンクリック時に、ScrollViewコントロールのScrollToAsyncメソッドを呼び出して、「Label07」という名前のLabelコントロールが中央に来るようにスクロールさせている。
なお、ScrollToAsyncメソッドは非同期メソッドであるが、スクロール完了後に行う処理はないため、async/awaitキーワードは使っていない。

 以上で完成だ。実行してボタンをタップすると、次の画像のようになる。

実行結果(縦置き画面。Visual Studio Emulator for Android)
実行結果(縦置き画面。Mac上のSimulator)
実行結果(縦置き画面。Mobile Emulator) 実行結果(縦置き画面)
上はVisual Studio Emulator for Androidでの実行結果。中はMac上のSimulatorでの実行結果。下はMobile Emulator(Windows 10)での実行結果。なお、Remoted iOS Simulator for Windowsを使用するにはVisual Studio Enterprise Editionのライセンスが必要となった(編集者がCommunity Editionを使っているため、本稿ではMac上のSimulatorでの画面キャプチャーとなっている)。使用方法についてはプレビュー段階の記事だが「XamarinアプリのMacでのビルドとiOS Simulator for Windows」を参照されたい。

まとめ

 スクロールできるようにするには、ScrollViewコントロールを使う。Orientationプロパティの設定で、縦にも横にもスクロールできる。また、コードビハインドからスクロールさせるには、ScrollToAsyncメソッドを使用する。

利用可能バージョン:Visual Studio 2015以降
カテゴリ:Xamarin 処理対象:Xamarin.Forms
関連TIPS:Xamarin.Forms:プラットフォームに応じて画面の一部を変えるには?
関連TIPS:Xamarin.Forms:プラットフォームに応じたフォントサイズを指定するには?


「.NET TIPS」のインデックス

.NET TIPS

Copyright© 1999-2017 Digital Advantage Corp. All Rights Reserved.

@IT Special

- PR -

TechTargetジャパン

Touch Barという新UIを得た「MacBook Pro」、プレゼント!

この記事に関連するホワイトペーパー

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。