WPF Prism episode: 20 ～ Prism ダイアログに MahApps.Metro が舞い降りた! ～

公開済み 2019年12月8日 · 更新済み 2020年8月6日

前回記事「MahApps.Metro と Material Design In XAML Toolkit たちは Prism でも余裕で生き抜くようです!【episode: 19 WPF Prism】」

前回は Prism のプロジェクトへ MahApps.Metro と Material Design In XAML Toolkit を導入する方法を紹介したので、今回は Prism から表示するメッセーボックスやダイアログを MahApps.Metro の MetroWindow で表示する方法を紹介します。

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

1 Material Design In XAML Toolkit の Style とコントロール
2 Livet の WindowCloseCancelBehavior で Window Close 時にメッセージを表示する
3 Prism から表示するダイアログを MetroWindow にする
4 おわりに

Material Design In XAML Toolkit の Style とコントロール

以前 episode: 6.5 で紹介したサンプルアプリは fig. 1 のような WPF 標準の良く見かける画面でした。

:: halation ghost ::

2018.12.10

WPF Prism episode: 6.5 ～いつだって Prism の画面遷移は RequestNavigate だっ...

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

前回記事「されどイベントは ViewModel と踊る【episode: 6 WPF Prism】」前回はコントロールのイベントを Command に変換して VM とバインドする方法を紹介したので、今回は Prism で View を動的に切り替える方法を紹介します。尚、この記事は Visual Studio 2017 Community Edition で .NET Framework 4.7.2 以上と C# + Prism 7.1 + ReactiveProperty を使用して、WPF アプリケーションを MVVM パターンで作成するのが目的で、C# での基本的なコーディング知識を持っている人が対象です。動的に表示する ViewView を動的に...

fig. 1 以前作成したサンプルアプリ

このサンプルアプリを元に Material Design In XAML Toolkit で装飾を軽く追加すると fig. 2 のような画面に変わります。

fig. 2 Material Design In XAML Toolkit のコントロール

この UI デザインを良いと思うかどうかは置いておいて、fig. 1 の画面と比べるとかなり雰囲気が変わったと思います。

TreeView のアイコンを画像ファイルから Material Design In XAML Toolkit の【PackIcon】に変更して、TextBox へ【MaterialDesignFloatingHintTextBox】を設定しただけで fig. 2 のような画面になるので色々試してみるだけでも楽しいと思います。

MahApps.Metro と Material Design In XAML Toolkit のアイコン

episode: 5 ではアセンブリリソースのアイコンを Image コントロールへ表示する方法を紹介しましたが、Material Design In XAML Toolkit をインストールすると src. 1 のように PackIcon コントロールが使用できるようになります。

:: halation ghost ::

2018.11.18

WPF Prism episode: 5 ～ TreeView の MVVM には ReactiveProperty が埋まっている～

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

前回記事「ReactiveProperty からはじまる MVVM 狂想曲【episode: 4.5 WPF Prism】」前回は VM ⇔ View 間のバインディングインタフェースに採用した ReactiveProperty を使った MVVM 入門編と ReactiveProperty（ReactiveCollection）を TreeView の ItemsSource に指定するまでを紹介したので、今回は TreeView を MVVM パターンで正しくバインドする方法と、ReactiveProperty 入門 part. 2 として基本的な Reactive Extension（Rx）を紹介しています。※ このエントリでは TreeView にバインドする例を紹介していますが、ListVi...

<UserControl x:Class="PrismNetCoreApp.NavigationTree"
             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:bh="http://schemas.microsoft.com/xaml/behaviors"
             xmlns:prism="http://prismlibrary.com/"
             xmlns:rp="clr-namespace:Reactive.Bindings.Interactivity;assembly=ReactiveProperty.NETCore"
             xmlns:md="http://materialdesigninxaml.net/winfx/xaml/themes"
             xmlns:ni="clr-namespace:PrismNetCoreApp.NavigationItems"
             mc:Ignorable="d"
             d:DesignHeight="300" d:DesignWidth="300"
             prism:ViewModelLocator.AutoWireViewModel="True">
    <UserControl.Resources>
        <ResourceDictionary>
            <HierarchicalDataTemplate x:Key="TreeItem"
                                      DataType="{x:Type ni:NavigationItemViewModel}"
                                      ItemsSource="{Binding Children}">
                <StackPanel Orientation="Horizontal">
                    <md:PackIcon Kind="{Binding IconImage.Value}"
                                 Width="24" Height="24"
                                 Foreground="{DynamicResource PrimaryHueMidBrush}"/>
                    <TextBlock VerticalAlignment="Center"
                               Style="{StaticResource MaterialDesignBody1TextBlock}"
                               Text="{Binding Text.Value}" />
                </StackPanel>
            </HierarchicalDataTemplate>
        </ResourceDictionary>
    </UserControl.Resources>
    ～ 略 ～
    <TreeView ItemsSource="{Binding TreeItems}"
              ItemTemplate="{StaticResource ResourceKey=TreeItem}">
        ～ 略 ～
    </TreeView>
</UserControl>

<UserControl x:Class="PrismNetCoreApp.NavigationTree"

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:bh="http://schemas.microsoft.com/xaml/behaviors"

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

xmlns:rp="clr-namespace:Reactive.Bindings.Interactivity;assembly=ReactiveProperty.NETCore"

xmlns:md="http://materialdesigninxaml.net/winfx/xaml/themes"

xmlns:ni="clr-namespace:PrismNetCoreApp.NavigationItems"

mc:Ignorable="d"

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

prism:ViewModelLocator.AutoWireViewModel="True">

<UserControl.Resources>

<HierarchicalDataTemplate x:Key="TreeItem"

DataType="{x:Type ni:NavigationItemViewModel}"

ItemsSource="{Binding Children}">

<md:PackIcon Kind="{Binding IconImage.Value}"

Width="24" Height="24"

Foreground="{DynamicResource PrimaryHueMidBrush}"/>

<TextBlock VerticalAlignment="Center"

Style="{StaticResource MaterialDesignBody1TextBlock}"

Text="{Binding Text.Value}" />

</StackPanel>

</HierarchicalDataTemplate>

</ResourceDictionary>

</UserControl.Resources>

～略～

<TreeView ItemsSource="{Binding TreeItems}"

ItemTemplate="{StaticResource ResourceKey=TreeItem}">

～略～

</TreeView>

</UserControl>

Material Design In XAML Toolkit デモアプリの IconPack View から表示したいアイコンを選んで Kind プロパティに設定するだけで表示でき、src. 1 のようにバインドした VM から設定することもできます。尚、サイズ指定は任意です。

fig.3 Material Design In XAML Toolkit デモアプリの IconPack View

このような SVG フォーマットのアイコンは Material Design In XAML Toolkit だけでなく MahApps.Metro にも多数含まれていますし、MahApps.Metro には本体とは別に IconPack も Nuget から入手できますが、Material Design In XAML Toolkit の PackIcon 程お手軽には扱えないのでアイコンは Material Design In XAML Toolkit の方だけを使った方が良いと管理人的には思います。（いろんな種類のアイコンを使うと統一感もなくなると思いますし…）

上記の文を訂正

↑上に『Material Design In XAML Toolkit の PackIcon 程お手軽には扱えない』と書いたのは間違いでした。

MahApps.Metro.IconPacks をインストールすれば Material Design In XAML Toolkit の PackIcon と同じくらい手軽に扱えます。

MahApps.Metro.IconPacks については【WPF UI Gallery case: 1-1 ～ MahApps.Metro の HamburgerMenu から Prism の RequestNavigate で画面を切り替える～】で紹介しているので良ければ読んでみてください。

:: 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 以...

2020/2/29 追記

又、PackIcon の Foreground を指定しないと黒で描画されますが、管理人的にちょっと味気なく感じたので Foreground にプライマリカラーを指定しています。
Material Design In XAML Toolkit では src. 1 の PackIcon.Foreground に指定しているように DynamicResource に定義された下表のような 8 種類の色を指定できます。

背景色	前景色	設定内容
PrimaryHueLightBrush	PrimaryHueLightForegroundBrush	明るいプライマリカラー
PrimaryHueMidBrush	PrimaryHueMidForegroundBrush	標準プライマリカラー
PrimaryHueDarkBrush	PrimaryHueDarkForegroundBrush	暗めのプライマリカラー
SecondaryAccentBrush	SecondaryAccentForegroundBrush	アクセントカラー

前景色は標準では白か黒なので、あまり指定することはないでしょうが、背景色を良い感じに使うと画面全体に統一感が出ると思います。

FloatingHint

又、src. 1 のように TextBox の Style へ【MaterialDesignFloatingHintTextBox】を設定すると fig. 2 のように項目ラベルを兼ねたウォーターマークが追加され軽い動きまで付加されるので管理人的には重宝しそうです。

【MaterialDesignFloatingHintTextBox】を設定すると以下のようなプロパティも有効になります。

プロパティ	設定内容
HintAssist.Hint	項目ラベル・ウォーターマークとして表示する文字列を指定します。
HintAssist.FloatingScale	HintAssist.Hint に設定した文字列がフローティング状態になった際のスケールを設定します。 0.8、0.9、1.2 のような指定が可能です。

尚、HintAssist には上表で紹介したプロパティ以外に HintAssist.FloatingOffse や HintAssist.HintOpacity 等のプロパティもありますが、読み取り専用のため設定はできません。

実際の XAML は以下の GitHub へのリンクから見てください。

GitHub

YouseiSakusen/WpfPractises

https://github.com/YouseiSakusen/WpfPractises/tree/master/18_episode20

WPF Prism Sample Application. Contribute to YouseiSakusen/WpfPractises development by creating an account on GitHub.

Livet の WindowCloseCancelBehavior で Window Close 時にメッセージを表示する

本章では episode: 18 でインストールした LivetCask.Behaviors.WindowCloseCancelBehavior を利用して Window Close 時に問い合わせメッセージを表示する方法を紹介します。

:: 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 で書き直したので、出来れば新規記事の方を見てく...

と思って試してみた所、そのままでは使えませんでした…
WindowCloseCancelBehavior は Window の Close を Cancel するためのだけのビヘイビアのようで、Windows Form で良く見かける「アプリケーションを終了してよろしいですか？」的なメッセージボックスの戻り値によって Window の Close をコントロールできる訳ではないようです。

とは言っても、GitHub で WindowCloseCancelBehavior のソースコードを見ると 1 か所修正するだけで管理人の希望通りに動いてくれそうなのでパクってみました。

GitHub

runceel/Livet

https://github.com/runceel/Livet/blob/master/LivetCask.Behaviors/WindowCloseCancelBehavior.cs

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

WindowCloseCancelBehavior を改造する

GitHub から WindowCloseCancelBehavior のソースコードを丸々コピーして新規に作成したビヘイビアが src. 2 の WindowClosingBehavior です。

using System;
using System.Diagnostics.CodeAnalysis;
using System.Windows;
using System.Windows.Input;
using Livet.Behaviors;
using Microsoft.Xaml.Behaviors;

namespace PrismNetCoreApp.Behaviors
{
    public class WindowClosingBehavior : Behavior<Window>
    {
        // Using a DependencyProperty as the backing store for CanClose.  This enables animation, styling, binding, etc...
        [NotNull]
        public static readonly DependencyProperty CanCloseProperty =
            DependencyProperty.Register("CanClose", typeof(bool), typeof(WindowClosingBehavior),
                new PropertyMetadata(true));

        // Using a DependencyProperty as the backing store for CloseCanceledCallbackCommand.  This enables animation, styling, binding, etc...
        [NotNull]
        public static readonly DependencyProperty CloseCanceledCallbackCommandProperty =
            DependencyProperty.Register("CloseCanceledCallbackCommand", typeof(ICommand),
                typeof(WindowClosingBehavior), new PropertyMetadata(null));

        // Using a DependencyProperty as the backing store for CloseCanceledCallbackMethodTarget.  This enables animation, styling, binding, etc...
        [NotNull]
        public static readonly DependencyProperty CloseCanceledCallbackMethodTargetProperty =
            DependencyProperty.Register("CloseCanceledCallbackMethodTarget", typeof(object),
                typeof(WindowClosingBehavior), new PropertyMetadata(null));

        // Using a DependencyProperty as the backing store for CloseCanceledCallbackMethodName.  This enables animation, styling, binding, etc...
        [NotNull]
        public static readonly DependencyProperty CloseCanceledCallbackMethodNameProperty =
            DependencyProperty.Register("CloseCanceledCallbackMethodName", typeof(string),
                typeof(WindowClosingBehavior), new PropertyMetadata(null));

        [NotNull] private readonly MethodBinder _callbackMethod = new MethodBinder();

        /// <summary>
        ///     このWindowを閉じることが可能かどうかを取得、または設定します。このプロパティがfalseを示す場合、WindowClose処理はキャンセルされます。デフォルト値はtrueです。
        /// </summary>
        public bool CanClose
        {
            get { return (bool)(GetValue(CanCloseProperty) ?? default(bool)); }
            set { SetValue(CanCloseProperty, value); }
        }

        /// <summary>
        ///     Windowを閉じる処理がこのビヘイビアによってキャンセルされた場合に実行するコマンドを取得、または設定します。
        /// </summary>
        public ICommand CloseCanceledCallbackCommand
        {
            get { return (ICommand)GetValue(CloseCanceledCallbackCommandProperty); }
            set { SetValue(CloseCanceledCallbackCommandProperty, value); }
        }

        /// <summary>
        ///     Windowを閉じる処理がこのビヘイビアによってキャンセルされた場合に実行するメソッドを持つオブジェクトを取得、または設定します。
        /// </summary>
        public object CloseCanceledCallbackMethodTarget
        {
            get { return GetValue(CloseCanceledCallbackMethodTargetProperty); }
            set { SetValue(CloseCanceledCallbackMethodTargetProperty, value); }
        }

        /// <summary>
        ///     Windowを閉じる処理がこのビヘイビアによってキャンセルされた場合に実行するメソッドの名前を取得、または設定します。
        /// </summary>
        public string CloseCanceledCallbackMethodName
        {
            get { return (string)GetValue(CloseCanceledCallbackMethodNameProperty); }
            set { SetValue(CloseCanceledCallbackMethodNameProperty, value); }
        }

        protected override void OnAttached()
        {
            var associatedObject = AssociatedObject;
            if (associatedObject == null) throw new InvalidOperationException();

            base.OnAttached();
            associatedObject.Closing += (sender, e) =>
            {
                if (e == null) throw new ArgumentNullException(nameof(e));

                if (CanClose) return;
                if (CloseCanceledCallbackCommand != null && CloseCanceledCallbackCommand.CanExecute(null))
                    CloseCanceledCallbackCommand.Execute(null);

                if (CloseCanceledCallbackMethodTarget != null && CloseCanceledCallbackMethodName != null)
                    _callbackMethod.Invoke(CloseCanceledCallbackMethodTarget, CloseCanceledCallbackMethodName);

                e.Cancel = !this.CanClose;
            };
        }
    }
}

using System;

using System.Diagnostics.CodeAnalysis;

using System.Windows;

using System.Windows.Input;

using Livet.Behaviors;

using Microsoft.Xaml.Behaviors;

namespace PrismNetCoreApp.Behaviors

{

public class WindowClosingBehavior : Behavior<Window>

{

// Using a DependencyProperty as the backing store for CanClose. This enables animation, styling, binding, etc...

[NotNull]

public static readonly DependencyProperty CanCloseProperty =

DependencyProperty.Register("CanClose", typeof(bool), typeof(WindowClosingBehavior),

new PropertyMetadata(true));

// Using a DependencyProperty as the backing store for CloseCanceledCallbackCommand. This enables animation, styling, binding, etc...

[NotNull]

public static readonly DependencyProperty CloseCanceledCallbackCommandProperty =

DependencyProperty.Register("CloseCanceledCallbackCommand", typeof(ICommand),

typeof(WindowClosingBehavior), new PropertyMetadata(null));

// Using a DependencyProperty as the backing store for CloseCanceledCallbackMethodTarget. This enables animation, styling, binding, etc...

[NotNull]

public static readonly DependencyProperty CloseCanceledCallbackMethodTargetProperty =

DependencyProperty.Register("CloseCanceledCallbackMethodTarget", typeof(object),

typeof(WindowClosingBehavior), new PropertyMetadata(null));

// Using a DependencyProperty as the backing store for CloseCanceledCallbackMethodName. This enables animation, styling, binding, etc...

[NotNull]

public static readonly DependencyProperty CloseCanceledCallbackMethodNameProperty =

DependencyProperty.Register("CloseCanceledCallbackMethodName", typeof(string),

typeof(WindowClosingBehavior), new PropertyMetadata(null));

[NotNull] private readonly MethodBinder _callbackMethod = new MethodBinder();

/// <summary>

/// このWindowを閉じることが可能かどうかを取得、または設定します。このプロパティがfalseを示す場合、WindowClose処理はキャンセルされます。デフォルト値はtrueです。

/// </summary>

public bool CanClose

{

get { return (bool)(GetValue(CanCloseProperty) ?? default(bool)); }

set { SetValue(CanCloseProperty, value); }

}

/// <summary>

/// Windowを閉じる処理がこのビヘイビアによってキャンセルされた場合に実行するコマンドを取得、または設定します。

/// </summary>

public ICommand CloseCanceledCallbackCommand

{

get { return (ICommand)GetValue(CloseCanceledCallbackCommandProperty); }

set { SetValue(CloseCanceledCallbackCommandProperty, value); }

}

/// <summary>

/// Windowを閉じる処理がこのビヘイビアによってキャンセルされた場合に実行するメソッドを持つオブジェクトを取得、または設定します。

/// </summary>

public object CloseCanceledCallbackMethodTarget

{

get { return GetValue(CloseCanceledCallbackMethodTargetProperty); }

set { SetValue(CloseCanceledCallbackMethodTargetProperty, value); }

}

/// <summary>

/// Windowを閉じる処理がこのビヘイビアによってキャンセルされた場合に実行するメソッドの名前を取得、または設定します。

/// </summary>

public string CloseCanceledCallbackMethodName

{

get { return (string)GetValue(CloseCanceledCallbackMethodNameProperty); }

set { SetValue(CloseCanceledCallbackMethodNameProperty, value); }

}

protected override void OnAttached()

{

var associatedObject = AssociatedObject;

if (associatedObject == null) throw new InvalidOperationException();

base.OnAttached();

associatedObject.Closing += (sender, e) =>

{

if (e == null) throw new ArgumentNullException(nameof(e));

if (CanClose) return;

if (CloseCanceledCallbackCommand != null && CloseCanceledCallbackCommand.CanExecute(null))

CloseCanceledCallbackCommand.Execute(null);

if (CloseCanceledCallbackMethodTarget != null && CloseCanceledCallbackMethodName != null)

_callbackMethod.Invoke(CloseCanceledCallbackMethodTarget, CloseCanceledCallbackMethodName);

e.Cancel = !this.CanClose;

};

}

実際に修正が必要だったのは src. 2 の 91 行目のみで他のハイライト行はビヘイビア名（クラス名）の変更に伴う修正です。この 91 行目は元々 true 固定で VM から CanClose プロパティを変更しても反映されなかったので CanClose の値を反映するよう修正しました。

WindowClosingBehavior をサンプルアプリに組み込む

WindowClosingBehavior は WindowCloseCancelBehavior を丸ごとコピーしただけなので XAML への組み込み方は WindowCloseCancelBehavior と全く同じで、src. 3 のハイライト部分を追加します。

<metro:MetroWindow x:Class="PrismNetCoreApp.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:bh="http://schemas.microsoft.com/xaml/behaviors"
                   xmlns:prism="http://prismlibrary.com/"
                   xmlns:l="http://schemas.livet-mvvm.net/2011/wpf"
                   xmlns:md="http://materialdesigninxaml.net/winfx/xaml/themes"
                   xmlns:local="clr-namespace:PrismNetCoreApp.Behaviors"
                   ～ 略 ～>
    <bh:Interaction.Behaviors>
        <local:WindowClosingBehavior CanClose="{Binding CanClose.Value}"
                                     CloseCanceledCallbackMethodTarget="{Binding}"
                                     CloseCanceledCallbackMethodName="ConfirmClose"/>
    </bh:Interaction.Behaviors>
    <bh:Interaction.Triggers>
        <bh:EventTrigger EventName="Closed">
            <l:DataContextDisposeAction />
        </bh:EventTrigger>
    </bh:Interaction.Triggers>
    ～ 略 ～
</metro:MetroWindow>

<metro:MetroWindow x:Class="PrismNetCoreApp.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:bh="http://schemas.microsoft.com/xaml/behaviors"

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

xmlns:l="http://schemas.livet-mvvm.net/2011/wpf"

xmlns:md="http://materialdesigninxaml.net/winfx/xaml/themes"

xmlns:local="clr-namespace:PrismNetCoreApp.Behaviors"

～略～>

<bh:Interaction.Behaviors>

<local:WindowClosingBehavior CanClose="{Binding CanClose.Value}"

CloseCanceledCallbackMethodTarget="{Binding}"

CloseCanceledCallbackMethodName="ConfirmClose"/>

</bh:Interaction.Behaviors>

<bh:Interaction.Triggers>

<bh:EventTrigger EventName="Closed">

<l:DataContextDisposeAction />

</bh:EventTrigger>

</bh:Interaction.Triggers>

～略～

</metro:MetroWindow>

WindowCloseCancelBehavior（WindowClosingBehavior）には ICommand とバインド可能な CloseCanceledCallbackCommand も用意されていますが、src. 3 の 11 ～ 15 行目のように記述すると Livet の Core 機能を利用して DataContext から CloseCanceledCallbackMethodName に指定した名前と同じメソッドを自動的にバインドしてくれるようです。

そのため、VM へ ICommand を定義する必要もなく WPF 標準のコマンドバインディングより高速に動作するようなので、Livet のお作法に則った指定にしています。

但し、src. 3 のようにバインドすると通常のコマンドバインディングと Livet のメソッドバインディングが混在してしまうため、統一したい場合は CloseCanceledCallbackCommand を呼ぶ方が良いかもしれません。（管理人は動作未確認）

CloseCanceledCallbackMethodName と併せて ReactvieProperty で定義している CanClose プロパティもバインドしているので XAML 側の CanClose に【.Value】を付ける必要がありますが、今回も【.Value】をつけ忘れてメソッドが呼ばれない原因に気付くのにしばらくかかってしまったので皆さんは忘れないように気を付けてください（苦笑）

そして src. 3 の MainWindow.xaml とバインドする VM が src. 4 です。

using System;
using System.Reactive.Disposables;
using Prism.Mvvm;
using Prism.Regions;
using Prism.Services.Dialogs;
using Prism.Services.Dialogs.Extensions;
using Reactive.Bindings;
using Reactive.Bindings.Extensions;

namespace PrismNetCoreApp
{
    /// <summary>アプリケーションのメイン画面を表します。</summary>
    public class MainWindowViewModel : BindableBase, IDisposable
    {
        ～ 略 ～
        /// <summary>WindowがClose可能かを取得します。</summary>
        public ReactivePropertySlim<bool> CanClose { get; }
        
        /// <summary>WindowのCloseを確認します。</summary>
        public void ConfirmClose()
            => this.CanClose.Value = this.dialogService.ShowConfirmationMessage("ウィンドウを閉じますか？") == ButtonResult.Yes;
        ～ 略 ～
        private IDialogService dialogService = null;
        ～ 略 ～
        /// <summary>コンストラクタ。</summary>
        public MainWindowViewModel(IRegionManager regionMan, IDialogService dlgService)
        {
            this.regionManager = regionMan;
            this.dialogService = dlgService;

            ～ 略 ～
            this.CanClose = new ReactivePropertySlim<bool>(false)
                .AddTo(this.disposables);
        }
    }
}

using System;

using System.Reactive.Disposables;

using Prism.Mvvm;

using Prism.Regions;

using Prism.Services.Dialogs;

using Prism.Services.Dialogs.Extensions;

using Reactive.Bindings;

using Reactive.Bindings.Extensions;

namespace PrismNetCoreApp

{

/// <summary>アプリケーションのメイン画面を表します。</summary>

public class MainWindowViewModel : BindableBase, IDisposable

{

～略～

/// <summary>WindowがClose可能かを取得します。</summary>

public ReactivePropertySlim<bool> CanClose { get; }

/// <summary>WindowのCloseを確認します。</summary>

public void ConfirmClose()

=> this.CanClose.Value = this.dialogService.ShowConfirmationMessage("ウィンドウを閉じますか？") == ButtonResult.Yes;

～略～

private IDialogService dialogService = null;

～略～

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

public MainWindowViewModel(IRegionManager regionMan, IDialogService dlgService)

{

this.regionManager = regionMan;

this.dialogService = dlgService;

～略～

this.CanClose = new ReactivePropertySlim<bool>(false)

.AddTo(this.disposables);

}

ConfirmClose 内で呼び出しているメッセーボックスは episode: 16 で紹介したメッセーボックスの実装を丸ごとコピーしただけなのでここでは紹介しません。必要な場合は GitHub か episode: 16 を見てください。

GitHub

YouseiSakusen/WpfPractises

https://github.com/YouseiSakusen/WpfPractises

WPF Prism Sample Application. Contribute to YouseiSakusen/WpfPractises development by creating an account on GitHub.

:: halation ghost ::

2019.08.03

WPF Prism episode: 16 ～ Prism7.2、ダイアログは IDialogService でって言ったよ...

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

前回記事「FolderBrowserDialog の為ならば、Prism の InteractionRequest はもしかしたらコモンダイアログも Popup できるかもしれない。【episode: 15 WPF Prism】」前回の episode: 15 で WPF Prism episode シリーズは一旦完結と書きましたが、Prism 7.2 が 2019/7/25 未明にリリースされ episode: 12 ～ 15 で紹介したメッセージボックスやダイアログウィンドウを表示する PopupWindowAction に変わって IDialogService が新規に追加され、ダイアログウィンドウの表示方法が大きく変わったので Prism 7.2 の新機能も紹介す...

実際の実装は src. 4 の通りですが、1 つだけ注意があって CanClose プロパティは Window.Close イベントが呼ばれる直前には必ず false に設定されている必要があることは覚えておいてください。Window.Close が呼ばれた時に true が設定されていると ConfirmClose コールバックは呼ばれません。

ここまでの状態で実行すると fig. 4 のように Window Close 時にメッセージが表示されるようになります。

fig. 4 ダイアログウィンドウとメッセーボックス

fig. 4 ではメッセーボックスだけでなくダイアログウィンドウも表示していますが、見て分かる通り両ウィンドウとも WPF の標準 Window で表示されています。

メッセージボックス、ダイアログウィンドウの両プロジェクトとも MahApps.Metro と Material Design In XAML Toolkit はインストール済みなのでボタン等は Material Design In XAML Toolkit のデザインテンプレートで表示されますが、継承元の変更が必要な MetroWindow には自動で変わりません。

Prism 7.1 までは『WPF PrismのPopupWindowActionで出すダイアログをMetroWindowにする – Qiita』に書かれている方法を使っていたようですが、Prism 7.2 からはかなり簡単になりました。

Qiita

WPF PrismのPopupWindowActionで出すダイアログをMetroWindowにする - Qiita

https://qiita.com/kuro4/items/1207323fde8fb233d212

# はじめにPrism.Wpfでダイアログを出す時、```xml:MainWindow.xaml<i:Interaction.Triggers> <prism:InteractionRequestTr...

Prism から表示するダイアログを MetroWindow にする

Prism 7.2 で導入された IDialogService から表示するウィンドウを MetroWindow にするにはまず、スタートアッププロジェクトへ src. 5 のような partial クラスを追加します。（クラス名は自由に付けて構いません）

using System.Windows;
using MahApps.Metro.Controls;
using Prism.Services.Dialogs;

namespace PrismNetCoreApp
{
    public partial class PrismNetCoreAppDialogWindow : MetroWindow, IDialogWindow
    {
        public IDialogResult Result { get; set; }
    }
}

using System.Windows;

using MahApps.Metro.Controls;

using Prism.Services.Dialogs;

namespace PrismNetCoreApp

{

public partial class PrismNetCoreAppDialogWindow : MetroWindow, IDialogWindow

{

public IDialogResult Result { get; set; }

}

追加した partial クラスを継承したい Window（ここでは MetroWindow）と IDialogWindow から継承して、IDialogWindow のメンバを実装します。

スタートアッププロジェクトへ追加と書きましたが、Prism の Shell か Module プロジェクトであればどこへ追加しても構いません。（IContainerRegistry へ登録できるプロジェクトであればどのプロジェクトでも構いません）
但し、この partial クラスは全ダイアログウィンドウで共有されるので管理人的には Shell のプロジェクトへ置くのが 1 番自然だと考えています。

そして、src. 6 のように RegisterTypes で DialogWindow として登録します。

using System;
using System.Reflection;
using System.Windows;
using Prism.Ioc;
using Prism.Modularity;
using Prism.Mvvm;
using PrismNetCoreApp.PersonalManagements;

namespace PrismNetCoreApp
{
    /// <summary>
    /// Interaction logic for App.xaml
    /// </summary>
    public partial class App
    {
        ～ 略 ～
        protected override void RegisterTypes(IContainerRegistry containerRegistry)
        {
            containerRegistry.RegisterInstance<IPrismNetCoreData>(new PrismNetCoreAgent().LoadData(this.dataFilePath));
            containerRegistry.RegisterDialogWindow<PrismNetCoreAppDialogWindow>();
        }
    }
}

using System;

using System.Reflection;

using System.Windows;

using Prism.Ioc;

using Prism.Modularity;

using Prism.Mvvm;

using PrismNetCoreApp.PersonalManagements;

namespace PrismNetCoreApp

{

/// <summary>

/// Interaction logic for App.xaml

/// </summary>

public partial class App

{

～略～

protected override void RegisterTypes(IContainerRegistry containerRegistry)

{

containerRegistry.RegisterInstance<IPrismNetCoreData>(new PrismNetCoreAgent().LoadData(this.dataFilePath));

containerRegistry.RegisterDialogWindow<PrismNetCoreAppDialogWindow>();

}

ここまで設定して実行すると fig. 5 のようにメッセージボックスもダイアログウィンドウも MetroWindow で表示されるようになります。

fig.5 Metroスタイルダイアログ

ダイアログを外からドラッグして来ているのは呼出元 Window から離れた位置に表示されるからです。
又、表示位置だけではなくタイトルも設定されていないのでちゃんと表示されるよう設定します。

Prism Dialog Window の設定

episode: 16 でも紹介しましたが、Prism 7.2 で導入された IDialogService から表示するダイアログのプロパティは src. 7 のように XAML から指定できます。

:: halation ghost ::

2019.08.03

WPF Prism episode: 16 ～ Prism7.2、ダイアログは IDialogService でって言ったよ...

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

<UserControl x:Class="PrismNetCoreApp.MessageBoxes.ConfirmMessageBox"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:prism="http://prismlibrary.com/"
             prism:ViewModelLocator.AutoWireViewModel="True"
             Width="300" Height="150">
    <prism:Dialog.WindowStyle>
        <Style TargetType="Window">
            <Setter Property="ResizeMode" Value="NoResize" />
            <Setter Property="ShowInTaskbar" Value="False" />
            <Setter Property="SizeToContent" Value="WidthAndHeight" />
        </Style>
    </prism:Dialog.WindowStyle>
    ～ 略 ～
</UserControl>

<UserControl x:Class="PrismNetCoreApp.MessageBoxes.ConfirmMessageBox"

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

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

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

prism:ViewModelLocator.AutoWireViewModel="True"

Width="300" Height="150">

<prism:Dialog.WindowStyle>

</Style>

</prism:Dialog.WindowStyle>

～略～

</UserControl>

但し、今回設定が必要な WindowStartupLocation は Dialog.WindowStyle から設定できません。
WindowStartupLocation は Window の Load 前に設定しないと反映されないため、Window Load 後に読み込まれる UserControl に書いても意味が無いからです。

では、WindowStartupLocation のように Dialog.WindowStyle から設定できないプロパティをどこで設定するかと言うと、追加した PrismNetCoreAppDialogWindow クラスは Window の単なるコードビハインドなので src. 8 のように記述するだけで前項の問題は解決できます。

using System.Windows;
using MahApps.Metro.Controls;
using Prism.Services.Dialogs;

namespace PrismNetCoreApp
{
    public partial class PrismNetCoreAppDialogWindow : MetroWindow, IDialogWindow
    {
        public IDialogResult Result { get; set; }

        /// <summary>WindowのLoadイベントハンドラ。</summary>
        /// <param name="sender">イベントのソース。</param>
        /// <param name="e">イベントデータを格納しているRoutedEventArgs。</param>
        private void PersonSelectWindow_Loaded(object sender, RoutedEventArgs e)
        {
            if (this.DataContext is IDialogAware)
                this.Title = (this.DataContext as IDialogAware).Title;

            this.Loaded -= this.PersonSelectWindow_Loaded;
        }

        /// <summary>コンストラクタ。</summary>
        public PrismNetCoreAppDialogWindow()
        {
            this.WindowStartupLocation = System.Windows.WindowStartupLocation.CenterOwner;

            this.Loaded += this.PersonSelectWindow_Loaded;
        }
    }
}

using System.Windows;

using MahApps.Metro.Controls;

using Prism.Services.Dialogs;

namespace PrismNetCoreApp

{

public partial class PrismNetCoreAppDialogWindow : MetroWindow, IDialogWindow

{

public IDialogResult Result { get; set; }

/// <summary>WindowのLoadイベントハンドラ。</summary>

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

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

private void PersonSelectWindow_Loaded(object sender, RoutedEventArgs e)

{

if (this.DataContext is IDialogAware)

this.Title = (this.DataContext as IDialogAware).Title;

this.Loaded -= this.PersonSelectWindow_Loaded;

}

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

public PrismNetCoreAppDialogWindow()

{

this.WindowStartupLocation = System.Windows.WindowStartupLocation.CenterOwner;

this.Loaded += this.PersonSelectWindow_Loaded;

}

コンストラクタで WindowStartupLocation を設定して、Load イベント内で DataContext から Title プロパティを取得して自分自身の Title へ設定するよう修正しています。

src. 8 のコードを追加して実行すると fig. 6 のように変わります。

fig.6 表示位置とタイトルを表示したダイアログウィンドウ

呼出元 Window の中央に表示されるようになり、タイトルも表示されるようになりました。
加えて Window 内に表示される View（UserControl）が Load される時に右から左へスライドする効果も付加されるようになるので、管理人的には結構満足しています。
ちなみに、Window 内部の View がスライドする効果は MetroWindow.WindowTransitionsEnabled で ON/OFF を切り替える事ができます。

MetroWindow のプロパティを XAML から設定する

WindowStartupLocation はプロパティの性質上、Prism ダイアログの partial から設定しましたが、ウィンドウが Load された後からでも反映可能なプロパティであれば、MetroWindow 固有のプロパティを src. 9 のように XAML から設定することができます。

<UserControl x:Class="PrismNetCoreApp.MessageBoxes.ConfirmMessageBox"
             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"
             Width="300" Height="150">
    <prism:Dialog.WindowStyle>
        <Style TargetType="metro:MetroWindow">
            <Setter Property="ResizeMode" Value="NoResize" />
            <Setter Property="ShowInTaskbar" Value="False" />
            <Setter Property="SizeToContent" Value="WidthAndHeight" />
            <Setter Property="TitleCharacterCasing" Value="Normal" />
        </Style>
    </prism:Dialog.WindowStyle>
    ～ 略 ～
</UserControl>

<UserControl x:Class="PrismNetCoreApp.MessageBoxes.ConfirmMessageBox"

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"

Width="300" Height="150">

<prism:Dialog.WindowStyle>

</Style>

</prism:Dialog.WindowStyle>

～略～

</UserControl>

src. 9 のように Style タグの TargetType に MetroWindow を設定すれば 13 行目のように MetroWindow 固有のプロパティを XAML から設定できます。

メッセージボックスではあまりメリットは無いかもしれませんが、MetroWindow で表示されるダイアログでは最小化ボタンや最大化ボタン、閉じるボタン等を非表示にすることもできます。

但し、episode: 19 で紹介した Window の位置やサイズを保存・復元する SaveWindowPosition に true を指定するのは注意が必要です。

:: halation ghost ::

2019.11.10

WPF Prism episode: 19 ～ MahApps.Metro と Material Design In XAML Toolkit た...

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

前回記事「Livet が Prism に「IDisposable 呼び出し用」としてゲッツされた件【episode: 18 WPF Prism】」前回は Livet の機能別パッケージを導入して Window と UserControl の VM を Dispose する方法を紹介しました。ここまでの連載では WPF アプリケーションを MVVM パターンで作成する場合の内部的な動作をメインに紹介してきましたが、やはり WPF と言えばスタイリッシュな画面を作成し易いのもウリだと思うので、今回は MahApps.Metro と Material Design In XAML Toolkit をサンプルアプリに組み込む方法を紹介します。...

SaveWindowPosition は WindowStartupLocation 等と違い Setter Property の候補にも出て来ますし実際に設定も可能ですが、単一の Window を使い回しているため位置もサイズも全ダイアログで共有されてしまう問題があるので、使用しない方が良いと思います。

このように、追加した partial クラスに IDialogWindow の継承を追加すると MahApps.Metro の MetroWindow だけでなく Infragistics の XamRibbonWindow や Fluent.Ribbon の RibbonWindow でダイアログを表示できるようになります。

jp.infragistics.com

XamRibbonWindow クラス - Infragistics WPF™ ヘルプ

https://jp.infragistics.com/help/wpf/infragisticswpf.ribbon~infragistics.windows.ribbon.xamribbonwindow

t Office 2007 アプリケーションと同じようにキャプション領域内の XamRibbon を表示するために設計された派生 System.Windows.Window クラス。 <!-- シンタックス Visual Basic C# '宣言   Public Class XamRibbonWind...

GitHub

fluentribbon/Fluent.Ribbon

https://github.com/fluentribbon/Fluent.Ribbon

WPF Ribbon control like in Office. Contribute to fluentribbon/Fluent.Ribbon development by creating an account on GitHub.

おわりに

さて、これで Prism 7.2 で追加された機能については全て紹介できたと思うので、WPF Prism episode シリーズとしてはしばらくお休みをして新シリーズを開始しようと思っています。

同じようなサンプルアプリばかりで少し飽きて来たので、別のアプリを作りながら WPF について紹介記事を書いていく予定なので、今までより更新間隔がさらに長くなりそうです。

そして今回紹介したソースコードもいつものように GitHub リポジトリに上げています。

GitHub

YouseiSakusen/WpfPractises

https://github.com/YouseiSakusen/WpfPractises

WPF Prism Sample Application. Contribute to YouseiSakusen/WpfPractises development by creating an account on GitHub.

タグ: IDialogService Livet MahApps.Metro Material Design In XAML Toolkit MetroWindow MVVM Prism Prism7.2 Prismダイアログ Prism入門 WPF メッセージボックス

匿名より:
2019年12月9日 19:16
以前、https://elf-mission.net/programming/wpf/episode12/ にて教えていただいた者です。
その節は大変お世話になりました。
episode16以降の記事を参考に、私が作成しているアプリケーションでPrismのバージョン7.2に対応させているところです。
そこでまた壁にぶつかっているので、ご教示いただけますでしょうか。
このアプリケーションにはメイン画面にメニューバーを持たせており、そこでアプリケーションを終了するという項目があります。
構成は
メイン画面（MainWindow、MainWindowViewModel）、
メニュー（MainMenuCtrl、MainMenuCtrlViewModel）
としています。
MainMenuCtrlの「アプリケーション終了」メニューからMainMenuCtrlViewModelのExitCommandが実行
→MainMenuCtrlViewModelからExitRequestを起こす
→MainMenuCtrlに設定したトリガアクションでWindowをClose
という流れにしているのですが、Prism7.2に準じてInteractionRequestを使わないようにしようと思えば
どのような実装になるのでしょうか？
読みづらくて申し訳ないのですが、下記が現在の実装です。
（そもそも現在の実装そのものがマズいのかもしれませんが）
MainMenuCtrl.xamlから抜粋

MainMenuCtrlViewModel.csから抜粋
public DelegateCommand ExitCommand { get; }
public InteractionRequest ExitRequest { get; } = new InteractionRequest();
public MainMenuCtrlViewModel()
{
ExitCommand = new DelegateCommand(() =>
{
// 終了処理を起こす
ExitRequest.Raise(null);
});
}
WindowCloseAction.csから抜粋
protected override void Invoke(object parameter)
{
Window.GetWindow(AssociatedObject)?.Close();
}
よろしくお願いいたします。
読み込み中…
返信
- 沖田玲朗より:
  2019年12月10日 23:42
  管理人です。
  episode: 12 でお役に立てたようなら良かったです。
  確かに Prism 7.2 からは InteractionRequest が Obsolute でマークされるので使わなくて済むなら使わなくしたいですよね…
  盲点でした。
  今まで VM 側から View を操作する例はあまり考えていなかったので悩む所ですが、調べてみて管理人なら以下の 2 つの内どちらかを使うと思います。
  ■ VMからウィンドウを閉じる添付ビヘイビア（http://sourcechord.hatenablog.com/entry/2014/04/05/225250）
  ■ ウィンドウを閉じるコマンドを ViewModel 側で実装する例（https://yoshiiz.blog.fc2.com/blog-entry-882.html）
  実装して試してみたいと思うのは『ウィンドウを閉じるコマンドを ViewModel 側で実装する例』の方ですが、Window を VM で操作するのは微妙な気がするのと、ビヘイビアを作っておけば他のプロジェクトへ使い回しもできるので最終的には『VMからウィンドウを閉じる添付ビヘイビア』側の方法を採用するような気がします。
  モヤっとするような回答しかできなくてすいません。
  読み込み中…
  返信
  - 匿名より:
    2019年12月11日 10:49
    回答ありがとうございます。
    両方の実装を試してみて、目的を達成できることを確認しました。
    ただ、私も添付ビヘイビアを使う方がしっくりきましたので、こちらを採用しようと思います。
    全然モヤっとするような内容ではありませんし、本当に助かりました。
    ありがとうございました。
    読み込み中…
    返信

コメントを残すコメントをキャンセル

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください。

WPF Prism episode: 20 ～ Prism ダイアログに MahApps.Metro が舞い降りた! ～

Material Design In XAML Toolkit の Style とコントロール

MahApps.Metro と Material Design In XAML Toolkit のアイコン

FloatingHint

Livet の WindowCloseCancelBehavior で Window Close 時にメッセージを表示する

WindowCloseCancelBehavior を改造する

WindowClosingBehavior をサンプルアプリに組み込む

Prism から表示するダイアログを MetroWindow にする

Prism Dialog Window の設定

MetroWindow のプロパティを XAML から設定する

おわりに

いいね:

おすすめ

3件のフィードバック

コメントを残すコメントをキャンセル

連載

最近の投稿

カテゴリー

メタ情報

WPF Prism episode: 20 ～ Prism ダイアログに MahApps.Metro が舞い降りた! ～

Material Design In XAML Toolkit の Style とコントロール

MahApps.Metro と Material Design In XAML Toolkit のアイコン

FloatingHint

Livet の WindowCloseCancelBehavior で Window Close 時にメッセージを表示する

WindowCloseCancelBehavior を改造する

WindowClosingBehavior をサンプルアプリに組み込む

Prism から表示するダイアログを MetroWindow にする

Prism Dialog Window の設定

MetroWindow のプロパティを XAML から設定する

おわりに

いいね:

おすすめ

WPF Prism episode: 9 ～ ReactiveProperty の Validation は DataAnnotation じゃないと思った？ ～

WPF Prism episode: 12 ～ Prism メッセージボックスの Service な日常 ～

WPF Prism episode: 15 ～ FolderBrowserDialog の為ならば、Prism の InteractionRequest はもしかしたらコモンダイアログも Popup できるかもしれない。 ～

3件のフィードバック

コメントを残す コメントをキャンセル

連載

最近の投稿

カテゴリー

メタ情報

WPF Prism episode: 9 ～ ReactiveProperty の Validation は DataAnnotation じゃないと思った？～

WPF Prism episode: 12 ～ Prism メッセージボックスの Service な日常～

WPF Prism episode: 15 ～ FolderBrowserDialog の為ならば、Prism の InteractionRequest はもしかしたらコモンダイアログも Popup できるかもしれない。～

コメントを残すコメントをキャンセル