Prism の Region に部分 View がいます。【step: 5 .NET Core WPF Prism MVVM 入門 2020】

公開済み 2020年8月20日 · 更新済み 2020年8月30日

前回記事「Prism の DI コンテナらは Ioc 上に歌う【step: 4 .NET Core WPF Prism MVVM 入門 2020】」

前回は Prism の DI コンテナの使い方と DI コンテナを活用して Ioc（Inversion of Control：制御の反転）を実現するための方法を紹介しました。今回は Prism の Region を操作する IRegionManager と、部分 View の表示と破棄について紹介します。

尚、この記事は Visual Studio 2019 Community Edition で .NET Core 3.1 以上と C# + Prism + MahApps.Metro + Material Design In XAML Toolkit を使用して、WPF アプリケーションを MVVM パターンで作成するのが目的なので、C# の文法や基本的なコーディング知識を持っている人が対象です。

1 Region とは
2 Shell で部分 View を表示する
3 Module で部分 View を表示する
4 Prism が Region として認識するコントロール
5 部分 View の Dispose
6 まとめ的な

Region とは

これまでにも何度か書きましたが、Prism は部分 View と呼ばれる UserControl を Window 上へ動的に表示することができ、部分 View を表示する領域の事を Region（リージョン）と呼びます。Region は Window 上へ 1 つ又は複数を同時に配置することができます。

Prism Template Pack の【Prism Blank App (.NET Core)】等から作成したプロジェクトに含まれる Window にはデフォルトで src. 1 のように Region が 1 つ配置されます。

<metro:MetroWindow x:Class="PrismSample.MainWindow"
                   xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                   xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
                   xmlns:metro="http://metro.mahapps.com/winfx/xaml/controls"
                   xmlns:prism="http://prismlibrary.com/"
                   prism:ViewModelLocator.AutoWireViewModel="True"
                   Title="{Binding Title}" Height="350" Width="525"
                   TitleCharacterCasing="Normal"
                   WindowStartupLocation="CenterScreen">
    <Grid>
        <ContentControl prism:RegionManager.RegionName="ContentRegion" />
    </Grid>
</metro:MetroWindow>

<metro:MetroWindow x:Class="PrismSample.MainWindow"

xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"

xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"

xmlns:metro="http://metro.mahapps.com/winfx/xaml/controls"

xmlns:prism="http://prismlibrary.com/"

prism:ViewModelLocator.AutoWireViewModel="True"

Title="{Binding Title}" Height="350" Width="525"

TitleCharacterCasing="Normal"

WindowStartupLocation="CenterScreen">

<Grid>

</Grid>

</metro:MetroWindow>

src. 1 の通り Region の実体は ContentControl 等のコントロールですが全てのコントロールが Region に設定できる訳ではありません。Region として使用できるコントロールについては後述しますが、以降では Region として使用できるコントロールの中でも使用頻度が高いと思われる ContentControl を例に Prism の Region について紹介します。

RegionManager

コントロールを Region として使用する場合、src. 1 の通り RegionManager 添付プロパティの RegionName へ一意の Region 名を指定します。複数の Region に同一名を設定すると『RegionCreationException』が Throw されます。

src. 1 で Region 名を指定している RegionManager 添付プロパティには RegionName 以外のプロパティも定義されていますが使用することはありません。

Shell で部分 View を表示する

Region は Window 上へ複数配置できますが、1 つの Region へ同時に表示できる部分 View は 1 つです。部分 View はスタートアッププロジェクトに含むこともできますが、前回紹介した通りスタートアッププロジェクトはアプリ基盤と言う位置付けのため、この連載ではスタートアッププロジェクトに部分 View を追加しません。

:: halation ghost ::

2020.08.02

Prism の DI コンテナらは Ioc 上に歌う【step: 4 .NET Core WPF Prism MVVM 入門 ...

https://elf-mission.net/programming/wpf/getting-started-2020/step04

前回記事「Prism はじめました【step: 3 .NET Core WPF Prism MVVM 入門 2020】」前回は Prism Template Pack から WPF アプリプロジェクトを作成して、MainWindow を表示するまでの最低限の手順を紹介しました。今回は Prism に組み込まれる DI コンテナについて紹介します。尚、この記事は Visual Studio 2019 Community Edition で .NET Core 3.1 以上と C# + Prism + MahApps.Metro + Material Design In XAML Toolkit を使用して、WPF アプリケーションを MVVM パターンで作成するのが目的なので、C# の文法や基本的なコー...

そのため fig. 1 のように部分 View を含む Module を新規追加しました。Module は複数の部分 View を含むこともできます。

fig. 1 部分 View を複数含んだ Module

step: 3 で紹介した通りこのサンプルアプリは ViewModelLocator の命名規則を変更しているため、View と VM を同一の名前空間に配置しています。

:: halation ghost ::

2020.07.17

Prism はじめました【step: 3 .NET Core WPF Prism MVVM 入門 2020】

https://elf-mission.net/programming/wpf/getting-started-2020/step03

前回記事「MVVM フレームワーク充のススメ【step: 2 .NET Core WPF MVVM 入門 2020】」前回は MVVM パターンの概要と WPF 用の MVVM フレームワークをいくつか紹介して、その中からこの連載で使用するフレームワークに Prism を選択しました。今回は Prism の概要とインストール手順及び、Prism を使用した WPF アプリの作成手順等を紹介します。尚、この記事は Visual Studio 2019 Community Edition で .NET Core 3.1 以上と C# に加えて Prism を使用して、WPF アプリケーションを MVVM パターンで作成するのが目的なので、C...

又、追加した Module にも MahApps.Metro と Material Design In XAML Toolkit をインストールしています。Module へのインストールについては WPF UI Gallery exhibition #1 で紹介しています。

:: halation ghost ::

2020.06.20

.NET Core 正式対応版 MahApps.Metro Ver. 2【exhibition #1 WPF UI Gallery】

https://elf-mission.net/programming/wpf/ui-gallery/exhibition01

WPF UI Gallery で紹介中の MahApps.Metro から .NET Core 対応版となる Ver.2.0.0 が正式リリースされました。そこで .NET Core 対応版が既にリリース済みの Material Design In XAML Toolkit と MahApps.Metro を統合して使用する場合のインストール手順と設定を紹介します。この連載は Visual Studio 2019 Community Edition で .NET 5.0 以上と C# + Prism 8.0 以降 + MahApps.Metro + Material Design In XAML Toolkit を使用して、WPF アプリケーションを MVVM パターンで作成するのが目的で、C# での基本的なコーディング知識...

尚、Module の部分 View は全て Border コントロールを 1 つ配置しただけの単純な UserControl で、View と同名の色を Border の Background へ設定しています。
以降では fig. 1 の ColorViews Module に置いた部分 View を Shell の Region に表示する方法を紹介します。

Shell に単一の部分 View を表示する

まずは src. 1 のように Shell 一杯に Region を 1 つ配置すると fig. 2 のような画面になります。

fig.2 単一 View

黄枠で囲んだ範囲が部分 View で ColorViews Module の Tomato.xaml を src. 2 のように表示しています。
※ スタートアッププロジェクトに ColorViews Module の参照を追加する必要があります。

using Prism.Mvvm;
using Prism.Regions;
using PrismSample.Red;

namespace PrismSample
{
    /// <summary>MainWindowのViewModel。</summary>
    public class MainWindowViewModel : BindableBase
    {
        ～ 略 ～
        /// <summary>コンストラクタ</summary>
        /// <param name="regMan">インジェクションするIRegionManager。</param>
        public MainWindowViewModel(IRegionManager regMan)
            => regMan.RegisterViewWithRegion("ContentRegion", typeof(Tomato));
    }
}

using Prism.Mvvm;

using Prism.Regions;

using PrismSample.Red;

namespace PrismSample

{

/// <summary>MainWindowのViewModel。</summary>

public class MainWindowViewModel : BindableBase

{

～略～

/// <summary>コンストラクタ</summary>

/// <param name="regMan">インジェクションするIRegionManager。</param>

public MainWindowViewModel(IRegionManager regMan)

=> regMan.RegisterViewWithRegion("ContentRegion", typeof(Tomato));

}

部分 View の表示には Prism が提供する IRegionManager を利用するため、前回紹介した通り Shell のコンストラクタへパラメータを追加して Prism（DI コンテナ）から IRegionManager をインジェクションしてもらいます。

:: halation ghost ::

2020.08.02

Prism の DI コンテナらは Ioc 上に歌う【step: 4 .NET Core WPF Prism MVVM 入門 ...

https://elf-mission.net/programming/wpf/getting-started-2020/step04

前回も紹介しましたが、Shell は部分 View を配置する土台なので、所謂ビジネスロジックのようなデータ操作は行いませんが、src. 2 のような UI 操作は行います。src. 2 では IRegionManager の RegisterViewWithRegion を呼び出して View の登録と Region への表示を一文で実行しています。

Region への部分 View 表示は IRegionManager の RequestNavigate 等でも可能ですが、アプリ起動時の部分 View 表示には RegisterViewWithRegion が便利です。RegisterViewWithRegion で表示した部分 View と VM は DI コンテナへの登録もされるため、部分 View（の VM）のコンストラクタへパラメータを追加すれば前回紹介したインジェクションも行われます。

Region に表示する部分 View の動的切り替えについては次回以降のエントリで紹介する予定なので、IRegionManager のプロパティやメソッド等はその都度紹介します。

Shell に複数の部分 View を表示する

Shell の MainWindow.xaml を src. 3 のように変更すると部分 View を複数表示することができます。

<metro:MetroWindow x:Class="PrismSample.MainWindow"
                   xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                   xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
                   xmlns:metro="http://metro.mahapps.com/winfx/xaml/controls"
                   xmlns:prism="http://prismlibrary.com/"
                   prism:ViewModelLocator.AutoWireViewModel="True"
                   Title="{Binding Title}" Height="350" Width="525"
                   TitleCharacterCasing="Normal"
                   WindowStartupLocation="CenterScreen">
    <Grid>
        <Grid.ColumnDefinitions>
            <ColumnDefinition Width="0.2*"/>
            <ColumnDefinition Width="0.8*"/>
        </Grid.ColumnDefinitions>
        <ContentControl Grid.Column="0"
                        prism:RegionManager.RegionName="RedContent" />
        <Grid Grid.Column="1">
            <Grid.RowDefinitions>
                <RowDefinition Height="0.7*"/>
                <RowDefinition Height="0.3*"/>
            </Grid.RowDefinitions>
            <ContentControl Grid.Row="0"
                            prism:RegionManager.RegionName="BlueContent" />
            <ContentControl Grid.Row="1"
                            prism:RegionManager.RegionName="GreenContent" />
        </Grid>
    </Grid>
</metro:MetroWindow>

<metro:MetroWindow x:Class="PrismSample.MainWindow"

xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"

xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"

xmlns:metro="http://metro.mahapps.com/winfx/xaml/controls"

xmlns:prism="http://prismlibrary.com/"

prism:ViewModelLocator.AutoWireViewModel="True"

Title="{Binding Title}" Height="350" Width="525"

TitleCharacterCasing="Normal"

WindowStartupLocation="CenterScreen">

<Grid>

<Grid.ColumnDefinitions>

</Grid.ColumnDefinitions>

<ContentControl Grid.Column="0"

prism:RegionManager.RegionName="RedContent" />

<Grid.RowDefinitions>

</Grid.RowDefinitions>

<ContentControl Grid.Row="0"

prism:RegionManager.RegionName="BlueContent" />

<ContentControl Grid.Row="1"

prism:RegionManager.RegionName="GreenContent" />

</Grid>

</metro:MetroWindow>

src. 3 のように ContentControl を 3 つ配置してそれぞれの RegionManager.RegionName へ違う名前を設定すると Shell へ 3 つの Region が配置されたことになります。

部分 View の表示は src. 2 と同じく src. 4 のように RegisterViewWithRegion で表示します。

using Prism.Mvvm;
using Prism.Regions;
using PrismSample.Blue;
using PrismSample.Green;
using PrismSample.Red;

namespace PrismSample
{
    /// <summary>MainWindowのViewModel。</summary>
    public class MainWindowViewModel : BindableBase
    {
        ～ 略 ～
        /// <summary>コンストラクタ</summary>
        /// <param name="regMan">インジェクションするIRegionManager。</param>
        public MainWindowViewModel(IRegionManager regMan)
        {
            regMan.RegisterViewWithRegion("RedContent", typeof(Tomato));
            regMan.RegisterViewWithRegion("BlueContent", typeof(DarkTurquoise));
            regMan.RegisterViewWithRegion("GreenContent", typeof(MediumSeaGreen));
        }
    }
}

using Prism.Mvvm;

using Prism.Regions;

using PrismSample.Blue;

using PrismSample.Green;

using PrismSample.Red;

namespace PrismSample

{

/// <summary>MainWindowのViewModel。</summary>

public class MainWindowViewModel : BindableBase

{

～略～

/// <summary>コンストラクタ</summary>

/// <param name="regMan">インジェクションするIRegionManager。</param>

public MainWindowViewModel(IRegionManager regMan)

{

regMan.RegisterViewWithRegion("RedContent", typeof(Tomato));

regMan.RegisterViewWithRegion("BlueContent", typeof(DarkTurquoise));

regMan.RegisterViewWithRegion("GreenContent", typeof(MediumSeaGreen));

}

3 つの Region に対して RegisterViewWithRegion を呼び出すと fig. 3 のような Shell になります。

fig.3 複数の部分 View

このように Shell のコンストラクタ等で IRegionManager.RegisterViewWithRegion を呼び出せば画面起動時に表示する View を指定することができます。

Module で部分 View を表示する

前章までは Shell 側に部分 View の表示を実装していましたが、Module 側に実装することもできます。Module 側に実装する場合は src. 5 のように IModule に処理を追加します。

using Prism.Ioc;
using Prism.Modularity;
using Prism.Regions;
using PrismSample.Red;

namespace PrismSample
{
    public class ColorViewsModule : IModule
    {
        /// <summary>Moduleを初期化します。</summary>
        /// <param name="containerProvider">取得用のDIコンテナインタフェースを表すIContainerProvider。</param>
        public void OnInitialized(IContainerProvider containerProvider)
        {
            var regionManager = containerProvider.Resolve<IRegionManager>();

            regionManager?.RegisterViewWithRegion("ContentRegion", typeof(Tomato));
        }

        /// <summary>DIコンテナへ型を登録します。</summary>
        /// <param name="containerRegistry">登録専用のDIコンテナを表すIContainerRegistry。</param>
        public void RegisterTypes(IContainerRegistry containerRegistry) { }
    }
}

using Prism.Ioc;

using Prism.Modularity;

using Prism.Regions;

using PrismSample.Red;

namespace PrismSample

{

public class ColorViewsModule : IModule

{

/// <summary>Moduleを初期化します。</summary>

/// <param name="containerProvider">取得用のDIコンテナインタフェースを表すIContainerProvider。</param>

public void OnInitialized(IContainerProvider containerProvider)

{

var regionManager = containerProvider.Resolve<IRegionManager>();

regionManager?.RegisterViewWithRegion("ContentRegion", typeof(Tomato));

}

/// <summary>DIコンテナへ型を登録します。</summary>

/// <param name="containerRegistry">登録専用のDIコンテナを表すIContainerRegistry。</param>

public void RegisterTypes(IContainerRegistry containerRegistry) { }

}

前章と同じく IRegionManager.RegisterViewWithRegion を使用するのは変わりませんが、IModule.OnInitialized のパラメータに渡される IContainerProvider から IRegionManager を取得するのが違う所です。

但し、前章と違ってスタートアッププロジェクトに Module の参照を追加するだけでなく src. 6 のように Module の登録処理も追加する必要があります。

using System;
using System.Reflection;
using System.Threading;
using System.Windows;
using Prism.Ioc;
using Prism.Modularity;
using Prism.Mvvm;

namespace PrismSample
{
    /// <summary>
    /// Interaction logic for App.xaml
    /// </summary>
    public partial class App
    {
        ～ 略 ～
        /// <summary>Moduleカタログを設定します。</summary>
        /// <param name="moduleCatalog">Moduleの一覧を表すIModuleCatalog。</param>
        protected override void ConfigureModuleCatalog(IModuleCatalog moduleCatalog)
        {
            base.ConfigureModuleCatalog(moduleCatalog);

            moduleCatalog.AddModule<ColorViewsModule>();
        }
        ～ 略 ～
    }
}

using System;

using System.Reflection;

using System.Threading;

using System.Windows;

using Prism.Ioc;

using Prism.Modularity;

using Prism.Mvvm;

namespace PrismSample

{

/// <summary>

/// Interaction logic for App.xaml

/// </summary>

public partial class App

{

～略～

/// <summary>Moduleカタログを設定します。</summary>

/// <param name="moduleCatalog">Moduleの一覧を表すIModuleCatalog。</param>

protected override void ConfigureModuleCatalog(IModuleCatalog moduleCatalog)

{

base.ConfigureModuleCatalog(moduleCatalog);

moduleCatalog.AddModule<ColorViewsModule>();

}

～略～

}

src. 6 の 25 行目にベースメソッドの呼び出しを残していますが、ベースメソッドは何も実装されていないので削除しても構いません。

src. 5 の IModule.OnInitialized は登録された Module しか呼び出されないので、src. 6 の IModuleCatalog.AddModule を忘れると OnInitialized は実行されません。複数の Region へ部分 View を表示する場合も src. 4 と同じく IRegionManager.RegisterViewWithRegion を複数回呼び出します。

部分 View 表示方法のまとめ

部分 View の表示を Shell 側に実装する場合と、Module 側に実装する方法を紹介しましたが、どちらが優れている等はありませんし、どちらが正しいと言う事もありません。管理人的に表示制御は Shell に集約されている方が見通し易いと思うので Shell 側に実装する方を選びます。

src. 6 の Module 登録を実装した場合は別の方法もあって、src. 7 のように Module 側では DI コンテナへの部分 View 登録のみ行います。

using Prism.Ioc;
using Prism.Modularity;
using PrismSample.Red;

namespace PrismSample
{
    public class ColorViewsModule : IModule
    {
        /// <summary>Moduleを初期化します。</summary>
        /// <param name="containerProvider">取得用のDIコンテナインタフェースを表すIContainerProvider。</param>
        public void OnInitialized(IContainerProvider containerProvider) { }

        /// <summary>DIコンテナへ型を登録します。</summary>
        /// <param name="containerRegistry">登録専用のDIコンテナを表すIContainerRegistry。</param>
        public void RegisterTypes(IContainerRegistry containerRegistry)
            => containerRegistry.RegisterForNavigation<Tomato, TomatoViewModel>();
    }
}

using Prism.Ioc;

using Prism.Modularity;

using PrismSample.Red;

namespace PrismSample

{

public class ColorViewsModule : IModule

{

/// <summary>Moduleを初期化します。</summary>

/// <param name="containerProvider">取得用のDIコンテナインタフェースを表すIContainerProvider。</param>

public void OnInitialized(IContainerProvider containerProvider) { }

/// <summary>DIコンテナへ型を登録します。</summary>

/// <param name="containerRegistry">登録専用のDIコンテナを表すIContainerRegistry。</param>

public void RegisterTypes(IContainerRegistry containerRegistry)

=> containerRegistry.RegisterForNavigation<Tomato, TomatoViewModel>();

}

そして表示処理は src. 8 のように Shell 側に実装すると言う方法です。

using Prism.Mvvm;
using Prism.Regions;
using PrismSample.Red;

namespace PrismSample
{
    /// <summary>MainWindowのViewModel。</summary>
    public class MainWindowViewModel : BindableBase
    {
        ～ 略 ～
        /// <summary>コンストラクタ</summary>
        /// <param name="regMan">インジェクションするIRegionManager。</param>
        public MainWindowViewModel(IRegionManager regMan)
            => regMan.RegisterViewWithRegion("ContentRegion", typeof(Tomato));
        }
    }
}

using Prism.Mvvm;

using Prism.Regions;

using PrismSample.Red;

namespace PrismSample

{

/// <summary>MainWindowのViewModel。</summary>

public class MainWindowViewModel : BindableBase

{

～略～

/// <summary>コンストラクタ</summary>

/// <param name="regMan">インジェクションするIRegionManager。</param>

public MainWindowViewModel(IRegionManager regMan)

=> regMan.RegisterViewWithRegion("ContentRegion", typeof(Tomato));

}

この方式だと Module 側は部分 View の登録のみ、Shell 側は表示指示のみと責務が分割されますが、実際は src. 7 の登録処理が無くても fig. 2 と同じ画面が表示されるので微妙な気はします。
IRegionManager.RegisterViewWithRegion も IContainerRegistry.RegisterForNavigation も DI コンテナへの登録を行いますが、登録重複エラー等にはならないようです。

管理人好みなのはアプリ起動時から終了まで表示し続ける部分 View は IRegionManager.RegisterViewWithRegion で登録、動的に切り替える部分 View は src. 7 のように IContainerRegistry.RegisterForNavigation で登録する方法です。

このように部分 View は色々な方法で表示できるので、前回紹介した DI コンテナからのインジェクションも含めて扱い易い方法を選択すれば良いと思います。

:: halation ghost ::

2020.08.02

Prism の DI コンテナらは Ioc 上に歌う【step: 4 .NET Core WPF Prism MVVM 入門 ...

https://elf-mission.net/programming/wpf/getting-started-2020/step04

部分 View に Region を追加

ここまで Region は Shell だけに配置していましたが、部分 View にも Region を追加できます。fig. 2 で表示した部分 View の Tomato.xaml を src. 9 のように変更します。

<UserControl x:Class="PrismSample.Red.Tomato"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
             xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
             xmlns:prism="http://prismlibrary.com/"
             mc:Ignorable="d" 
             d:DesignHeight="300" d:DesignWidth="300"
             prism:ViewModelLocator.AutoWireViewModel="True">
    <Grid>
        <Grid.ColumnDefinitions>
            <ColumnDefinition Width="0.7*"/>
            <ColumnDefinition Width="0.3*"/>
        </Grid.ColumnDefinitions>
        <Border Grid.Column="0" Background="Tomato" />
        <ContentControl Grid.Column="1"
                        prism:RegionManager.RegionName="BlueContent" />
    </Grid>
</UserControl>

<UserControl x:Class="PrismSample.Red.Tomato"

xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"

xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"

xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"

xmlns:d="http://schemas.microsoft.com/expression/blend/2008"

xmlns:prism="http://prismlibrary.com/"

mc:Ignorable="d"

d:DesignHeight="300" d:DesignWidth="300"

prism:ViewModelLocator.AutoWireViewModel="True">

<Grid>

<Grid.ColumnDefinitions>

</Grid.ColumnDefinitions>

<ContentControl Grid.Column="1"

prism:RegionManager.RegionName="BlueContent" />

</Grid>

</UserControl>

そして src. 10 のように Tomato 部分 View の VM へ DarkTurquoise の表示処理を追加します。

using Prism.Mvvm;
using Prism.Regions;
using PrismSample.Blue;

namespace PrismSample.Red
{
    /// <summary>トマトViewのViewModel。</summary>
    public class TomatoViewModel : BindableBase
    {
        /// <summary>コンストラクタ。</summary>
        /// <param name="regMan">DIコンテナからインジェクションするIRegionManager。</param>
        public TomatoViewModel(IRegionManager regMan)
            => regMan.RegisterViewWithRegion("BlueContent", typeof(DarkTurquoise));
    }
}

using Prism.Mvvm;

using Prism.Regions;

using PrismSample.Blue;

namespace PrismSample.Red

{

/// <summary>トマトViewのViewModel。</summary>

public class TomatoViewModel : BindableBase

{

/// <summary>コンストラクタ。</summary>

/// <param name="regMan">DIコンテナからインジェクションするIRegionManager。</param>

public TomatoViewModel(IRegionManager regMan)

=> regMan.RegisterViewWithRegion("BlueContent", typeof(DarkTurquoise));

}

Shell の場合と同くインジェクションされる IRegionManager の RegisterViewWithRegion を呼び出すと fig. 4 のような Shell が表示されます。

fig.4 部分 View 上の Region

黄枠がそれぞれ部分 View なので、想定通りの画面になっていると思います。又、src. 10 の 13 行目は Shell 側に実装しても fig. 4 と全く同じ画面が表示されるので、どちらで呼び出しても構いません。

このように Region を部分 View に配置しても Shell と同じように表示できます。但し、今回は同一 Module 内の部分 View を表示しているので、例えば別 Module の部分 View を指定した場合はどうか？とか、部分 View 上の Region で View 切り替えを実行した場合はどうか？等は試していないので、又、Region の View 動的切り替えを紹介する辺りで試してみます。

ContentControl を継承したコントロール

これまでの Region は全て ContentControl を使用してきましたが、実は ContentControl を継承したコントロールであれば Region として使用できます。

docs.microsoft.com

ContentControl クラス (System.Windows.Controls)

https://docs.microsoft.com/ja-jp/dotnet/api/system.windows.controls.contentcontrol?view=netcore-3.1

任意の種類のコンテンツが 1 つあるコントロールを表します。Represents a control with a single piece of content of any type.

.NET API ブラウザーで ContentControl を確認すると Window や HeaderedContentControl が派生コントロールなので、Window や GroupBox（HeaderedContentControl から派生）でも『prism:RegionManager.RegionName=”Region 名”』を追加すれば Region として使用できます。

又、WPF UI Gallery case: 1-1 で紹介している MahApps.Metro の HamburgerMenu や TransitionContentControl も ContentControl を継承したコントロールなので、Region として使用可能です。

:: halation ghost ::

2020.02.29

MahApps.Metro の HamburgerMenu から Prism の RequestNavigate で画面を切り替え...

https://elf-mission.net/programming/wpf/ui-gallery/case01-01

WPF MVVM L@bo シリーズも始めたばかりで大して進んでいないにもかからわず新たに別シリーズを立ち上げることにしました。今回の連載はタイトル通り UI 部品の紹介をメインに進めていく予定で、紹介する UI ライブラリは GitHub で公開されているものをメインに取り上げていきたいと思っています。そして第 1 回目は WPF Prism episode、WPF MVVM L@bo 両シリーズでも既に紹介済みですが、MahApps.Metro と Material Design In XAML Toolkit を取り上げます。尚、この連載は Visual Studio 2019 Community Edition で .NET Core 3.1 以...

ContentControl を Region として使用する場合の注意点が 1 つあります。ContentControl は Focusable のデフォルト値が true なので Tab キー等でフォーカスを移動すると ContentControl 自体がフォーカスを受け取ってしまうため画面上からフォーカスが消えたように見えてしまいます。

これを避けるために ContentControl.Focusable に false を設定するのを忘れないようにしてください。
（2020/8/30 追記）

Prism が Region として認識するコントロール

Prism で Region として認識するコントロールは ContentControl 以外も用意されていて、前回も紹介した PrismInitializationExtensions クラスの RegisterDefaultRegionAdapterMappings で登録されているコントロールが Region として使用できます。

:: halation ghost ::

2020.08.02

Prism の DI コンテナらは Ioc 上に歌う【step: 4 .NET Core WPF Prism MVVM 入門 ...

https://elf-mission.net/programming/wpf/getting-started-2020/step04

GitHub

PrismLibrary/Prism

https://github.com/PrismLibrary/Prism/blob/master/src/Wpf/Prism.Wpf/PrismInitializationExtensions.cs

Prism is a framework for building loosely coupled, maintainable, and testable XAML applications in WPF, Xamarin Forms, and Uno / Win UI Applications.. - PrismLibrary/Prism

RegisterDefaultRegionAdapterMappings で登録しているコントロールは以下の 3 つです。

Selector
ItemsControl
ContentControl

上記 3 コントロールは Prism 内部で登録済みなので Region として使用できます。又、上記 3 コントロールから派生したコントロールも同じく Region として使用できますが、使用方法は ContentControl とほとんど変わらないはずなのでここでは紹介しません。興味がある人は試してみてください。

Region として使用するコントロールを追加する

コントロールを Region として使用するには IRegionAdapter を継承したクラスを作成する必要があります。管理人はあまり必要性を感じた事が無いので試した事がありませんが、Prism 公式サンプルの【03-CustomRegions】で StackPanel を Region として使用する例が紹介されているので、そちらを見てください。

GitHub

PrismLibrary/Prism-Samples-Wpf

https://github.com/PrismLibrary/Prism-Samples-Wpf/tree/master/03-CustomRegions

Samples that demonstrate how to use various Prism features with WPF - PrismLibrary/Prism-Samples-Wpf

情報はあまり多くないと思いますが、もし必要であれば【IRegionAdapter】等のキーワードで検索すればいくつか見つかると思います。

部分 View の Dispose

ここまでは部分 View の表示について紹介して来ましたが、本章では部分 View の破棄について紹介します。Prism の部分 View として使用する UserControl は Windows Form の UserControl とは違って IDisposable を継承していないため UserControl 自体の破棄は不要ですが、VM を破棄したいと思う事は多いと思います。

docs.microsoft.com

UserControl クラス (System.Windows.Controls)

https://docs.microsoft.com/ja-jp/dotnet/api/system.windows.controls.usercontrol?view=netcore-3.1

コントロールを作成するための簡単な方法を提供します。Provides a simple way to create a control.

Prism Ver. 7.1.0 以前は部分 View の破棄はサポートされていなかったため『[Prism]UserControlの削除時にView/ViewModelをDisposeする – Qiita』のような Behavior を作成していたと思います。

Qiita

[Prism]UserControlの削除時にView/ViewModelをDisposeする - Qiita

https://qiita.com/hsytkm/items/70b5bf43b881cc4fe6cf

はじめにPrism にて、Region に登録されている UserControl を削除する際に、ViewModel 及び View の Disposeメソッドをコールする方法についてまとめます。国産MVVMインフラの...

ですが、Ver. 7.2.0.1367 から Xamarin 用の Prism に組み込まれていた IDestructible が WPF 版にも組み込まれたため部分 View の破棄が容易になりました。

IDestructible インタフェース

部分 View の VM を破棄するには src. 11 のように IDestructible から継承するよう変更します。

using Prism.Mvvm;
using Prism.Navigation;
using Prism.Regions;

namespace PrismSample.Red
{
    /// <summary>トマトViewのViewModel。</summary>
    public class TomatoViewModel : BindableBase, IDestructible
    {
        /// <summary>コンストラクタ。</summary>
        /// <param name="regMan">DIコンテナからインジェクションするIRegionManager。</param>
        public TomatoViewModel(IRegionManager regMan) { }

        /// <summary>このVMを破棄します。</summary>
        public void Destroy()
        {
            // Dispose処理を実装する
        }
    }
}

using Prism.Mvvm;

using Prism.Navigation;

using Prism.Regions;

namespace PrismSample.Red

{

/// <summary>トマトViewのViewModel。</summary>

public class TomatoViewModel : BindableBase, IDestructible

{

/// <summary>コンストラクタ。</summary>

/// <param name="regMan">DIコンテナからインジェクションするIRegionManager。</param>

public TomatoViewModel(IRegionManager regMan) { }

/// <summary>このVMを破棄します。</summary>

public void Destroy()

{

// Dispose処理を実装する

}

IDestructible インタフェースは Destroy メソッドが 1 つ定義されているだけのシンプルなインタフェースなので、src. 11 のように Destroy メソッドへ破棄が必要な処理を追加します。src. 11 では破棄するオブジェクト等が存在しないため何も実装していません。

Prism が IDestructible.Destroy を呼び出すのは Region から部分 View を Remove する場合だけなので、どこかで Remove を呼び出す必要があります。部分 View の VM を破棄するタイミングはそれぞれ作成するアプリ毎に違うと思いますが、アプリ終了時に部分 View を全て破棄したいと考える事は多いと思います。

Shell の VM を Dispose する

アプリ終了時に全部分 View の VM を破棄するついでに Shell（MainWindow）の VM も破棄できた方が良いと思うので、src. 12 のように Shell の VM を IDisposable から継承するように変更して Dispose メソッドで Region の Remove 処理を呼び出します。

using System;
using Prism.Mvvm;
using Prism.Regions;
using PrismSample.Blue;
using PrismSample.Green;
using PrismSample.Red;

namespace PrismSample
{
    /// <summary>MainWindowのViewModel。</summary>
    public class MainWindowViewModel : BindableBase, IDisposable
    {
        ～ 略 ～
        private IRegionManager regionManager = null;

        /// <summary>コンストラクタ</summary>
        /// <param name="regMan">インジェクションするIRegionManager。</param>
        public MainWindowViewModel(IRegionManager regMan)
        {
            this.regionManager = regMan;
            ～ 略 ～
        }

        private bool disposedValue;

        protected virtual void Dispose(bool disposing)
        {
            if (!disposedValue)
            {
                if (disposing)
                {
                    // TODO: マネージド状態を破棄します (マネージド オブジェクト)
                    foreach (var region in this.regionManager.Regions)
                    {
                        region.RemoveAll();
                    }
                }

                disposedValue = true;
            }
        }
        ～ 略 ～
    }
}

using System;

using Prism.Mvvm;

using Prism.Regions;

using PrismSample.Blue;

using PrismSample.Green;

using PrismSample.Red;

namespace PrismSample

{

/// <summary>MainWindowのViewModel。</summary>

public class MainWindowViewModel : BindableBase, IDisposable

{

～略～

private IRegionManager regionManager = null;

/// <summary>コンストラクタ</summary>

/// <param name="regMan">インジェクションするIRegionManager。</param>

public MainWindowViewModel(IRegionManager regMan)

{

this.regionManager = regMan;

～略～

}

private bool disposedValue;

protected virtual void Dispose(bool disposing)

{

if (!disposedValue)

{

if (disposing)

{

// TODO: マネージド状態を破棄します (マネージドオブジェクト)

foreach (var region in this.regionManager.Regions)

{

region.RemoveAll();

}

disposedValue = true;

}

～略～

}

IRegionManager.Regions にはアプリ内に配置した全ての Region が格納されているので、33 ～ 36 行目のように Region 毎に RemoveAll を呼び出せば表示済み部分 View（VM）の IDestructible.Destroy が Prism から呼び出されます。

ここでは全ての部分 View を破棄したいので RemoveAll を呼び出していますが、IRegionManager.Regions の IRegionCollection は IEnumerable を継承しているので src. 13 のように指定した部分 View のみ削除できます。

// RedContent：Region 名
var targetRegion = this.regionManager.Regions.First(r => r.Name == "RedContent");
// Tomato：View 名
targetRegion?.Remove(targetRegion.GetView("Tomato"));

// RedContent：Region 名

var targetRegion = this.regionManager.Regions.First(r => r.Name == "RedContent");

// Tomato：View 名

targetRegion?.Remove(targetRegion.GetView("Tomato"));

そして、Shell の VM を破棄するために、どこかで Dispose メソッドを呼び出す必要があるので、src. 14 のように Shell（MainWindow）のコードビハインドで Closed イベントをハンドルします。

using System;
using MahApps.Metro.Controls;

namespace PrismSample
{
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : MetroWindow
    {
        public MainWindow()
            => InitializeComponent();

        /// <summary>Closedイベントハンドラ。</summary>
        /// <param name="sender">イベントのソース。</param>
        /// <param name="e">イベントデータを格納しているEventArgs。</param>
        private void MetroWindow_Closed(object sender, System.EventArgs e)
            => (this.DataContext as IDisposable)?.Dispose();
    }
}

using System;

using MahApps.Metro.Controls;

namespace PrismSample

{

/// <summary>

/// Interaction logic for MainWindow.xaml

/// </summary>

public partial class MainWindow : MetroWindow

{

public MainWindow()

=> InitializeComponent();

/// <summary>Closedイベントハンドラ。</summary>

/// <param name="sender">イベントのソース。</param>

/// <param name="e">イベントデータを格納しているEventArgs。</param>

private void MetroWindow_Closed(object sender, System.EventArgs e)

=> (this.DataContext as IDisposable)?.Dispose();

}

src. 14 のように Window の DataContext を Dispose すれば、部分 View の VM も破棄されます。src. 14 を見て『コードビハインド？』と思う人も居るかもしれませんが、単なる終了処理のような実装はコードビハインドに書いても MVVM パターンが崩れる訳ではありません。

ですが、src. 14 のような VM の Dispose 処理は他のアプリでも使いたい場合も多いと思います。Windows Form では Form を継承して処理を共通化する事も多かったと思いますが、WPF では Window を継承しなくても処理の共通化ができる仕組みが提供されています。

DataContext を Dispose するアクション

継承を利用した処理の共通化は手軽ですが、共通処理の追加・削除等には不向きなので WPF では共通処理を部品として作成可能なアクションや Behavior が導入されました。部品として再利用し易くなったので、DataContext の Dispose に WPF Prism episode: 18 で紹介した Livet のパッケージを利用する手もありますが、ソースファイル 1 つだけならそのままパクってプロジェクトに組み込んでも構わないと思います。

:: halation ghost ::

2019.10.26

WPF Prism episode: 18 ～ Livet が Prism に「IDisposable 呼び出し用」としてゲ...

https://elf-mission.net/programming/wpf/episode18

前回記事「IDialogService にコモンダイアログを求めるのは間違っているだろうか【episode: 17 WPF Prism】」前回までは Prism 7.2 に新たに追加された IDialogService について紹介しました。今回は .NET Core 3.0 がリリースされたので、今まで WPF Prism episode シリーズで紹介してきたサンプルアプリを .NET Core 3.0 のアプリケーションとして新規に書き換えることにしました。2020/8/20 追記このエントリの内容を新規連載の .NET Core WPF Prism MVVM 入門 2020 step: 5 で書き直したので、出来れば新規記事の方を見てく...

src. 14 の DataContext.Dispose は Livet の DataContextDisposeAction そのままなので、Livet をインストールせずソースコードを流用させてもらっています。

GitHub

runceel/Livet

https://github.com/runceel/Livet/blob/886c274c15a8e0471eb44019ea55201dde822d17/LivetCask.Behaviors/DataContextDisposeAction.cs

WPF MVVM Infrastructure. Contribute to runceel/Livet development by creating an account on GitHub.

src. 15 のクラスを作成してスタートアッププロジェクトに追加します。

using System;
using System.Windows;
using Microsoft.Xaml.Behaviors;

namespace PrismSample
{
    public class DataContextDisposeAction : TriggerAction<FrameworkElement>
    {
        protected override void Invoke(object parameter)
            => (this.AssociatedObject?.DataContext as IDisposable)?.Dispose();
    }
}

using System;

using System.Windows;

using Microsoft.Xaml.Behaviors;

namespace PrismSample

{

public class DataContextDisposeAction : TriggerAction<FrameworkElement>

{

protected override void Invoke(object parameter)

=> (this.AssociatedObject?.DataContext as IDisposable)?.Dispose();

}

src. 15 は XAML から呼び出せるアクションとして利用できます。ここではスタートアッププロジェクトに追加していますが、他のプロジェクトなどに使い回すなら別プロジェクトに分ける方が良いと思います。src. 15 のアクション呼び出しには【System.Windows.Interactivity.dll から Xaml.Behaviors.Wpf へ】で紹介した Xaml.Behaviors.Wpf を利用します。

:: halation ghost ::

2020.08.16

System.Windows.Interactivity.dll から Xaml.Behaviors.Wpf へ

https://elf-mission.net/programming/wpf/wpf-tips/xaml-behaviors-wpf-interactivity

WPF アプリを作成するためには欠かせない System.Windows.Interactivity.dll が OSS になり名前も変わった Xaml.Behaviors.Wpf について紹介します。

『System.Windows.Interactivity.dll から Xaml.Behaviors.Wpf へ』でも紹介した通り、スタートアッププロジェクトには MahApps.Metro がインストール済のはずなので Xaml.Behaviors.Wpf をわざわざインストールする必要は無く、src. 16 のように Shell の XAML へ DataContextDisposeAction を呼び出しを追加します。

<metro:MetroWindow x:Class="PrismSample.MainWindow"
                   xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                   xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
                   xmlns:bh="http://schemas.microsoft.com/xaml/behaviors"
                   xmlns:metro="http://metro.mahapps.com/winfx/xaml/controls"
                   xmlns:prism="http://prismlibrary.com/"
                   xmlns:local="clr-namespace:PrismSample"
                   prism:ViewModelLocator.AutoWireViewModel="True"
                   Title="{Binding Title}" Height="350" Width="525"
                   TitleCharacterCasing="Normal"
                   WindowStartupLocation="CenterScreen">
    <bh:Interaction.Triggers>
        <bh:EventTrigger EventName="Closed">
            <local:DataContextDisposeAction />
        </bh:EventTrigger>
    </bh:Interaction.Triggers>
    <Grid>
        ～ 略 ～
    </Grid>
</metro:MetroWindow>

<metro:MetroWindow x:Class="PrismSample.MainWindow"

xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"

xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"

xmlns:bh="http://schemas.microsoft.com/xaml/behaviors"

xmlns:metro="http://metro.mahapps.com/winfx/xaml/controls"

xmlns:prism="http://prismlibrary.com/"

xmlns:local="clr-namespace:PrismSample"

prism:ViewModelLocator.AutoWireViewModel="True"

Title="{Binding Title}" Height="350" Width="525"

TitleCharacterCasing="Normal"

WindowStartupLocation="CenterScreen">

<bh:Interaction.Triggers>

<bh:EventTrigger EventName="Closed">

<local:DataContextDisposeAction />

</bh:EventTrigger>

</bh:Interaction.Triggers>

<Grid>

～略～

</Grid>

</metro:MetroWindow>

Xaml.Behaviors.Wpf の【Interaction.Triggers】へトリガーとして【EventTrigger】を指定すると【EventName】に設定したイベントが発火したタイミングでアクションが呼び出されます。【EventName】には対象コントロール（ここでは Window）から発火するイベントはどれでも指定できる（はずな）ので .NET API ブラウザー等で探してください。

docs.microsoft.com

Window クラス (System.Windows)

https://docs.microsoft.com/ja-jp/dotnet/api/system.windows.window?view=netcore-3.1

ウィンドウおよびダイアログボックスの作成、構成、表示、および有効期間の管理を可能にします。Provides the ability to create, configure, show, and manage the lifetime of windows and dialog boxes.

src. 16 のアクション呼び出しを追加すると src. 14 で紹介した MetroWindow_Closed イベントをコメントアウトしても部分 View や Shell の VM を破棄する処理が実行されることが確認できます。
※ Dispose や Destroy 等にブレークポイントを置いて確認してください。

アクションや Behavior について

DataContext の Dispose 呼び出しはかなり遠回しな紹介でしたが、アクションや Behavior は再利用可能な部品を作成する手段として用意されていますが、コードビハインドへの記述を避けるために用意されている訳ではない事を分かって欲しかったからです。

本章で紹介したように、他プロジェクト等で再利用するためであればアクションや Behavior を作成すれば良いと思いますが、そのプロジェクトでしか使用しないような処理ならコードビハインドで充分なので、アクションや Behavior を作成する手間をかけるかの検討は必要だと思います。

まとめ的な

Region だけで 1 エントリ埋まるか心配でしたが予想以上に書くことがありました。Prism の Region について全網羅できたとは思いませんが、現時点で管理人が知っていることはほとんど書けたと思います。隠しネタ的な情報もあるにはありますが、イマイチ使いどころが無いので又機会があれば紹介するつもりです。

一応、この連載は WPF Prism episode シリーズの焼き直しとして書き始めましたが、1 番の理由は何か新しい方法を見つけても WPF Prism episode シリーズだと情報がバラけ過ぎていて追記するエントリが決まらないからです。

:: halation ghost ::

2019.03.08