[UWP]ValidatableBindableBaseを使用して、検証結果のエラーメッセージを表示させたい

Question

前提・実現したいこと

UWP初心者です。
ValidatableBindableBaseを継承したMainPageViewModelのMessageというプロパティにDataAnnotationsの検証用属性をつけて、View側で検証結果をBindして表示させたいです。

該当のソースコード

// MainPageViewModel.cs
using Prism.Windows.Validation;
using System.ComponentModel.DataAnnotations;

namespace ValidatableBindableBaseApp.ViewModels
{
    public class MainPageViewModel : ValidatableBindableBase
    {
        private string message;

        [Required(ErrorMessage ="Required")]
        public string Message
        {
            get { return this.message; }
            set { this.SetProperty(ref this.message, value); }
        }

    }
}
// MainPage.xaml
<Page
    x:Class="ValidatableBindableBaseApp.Views.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="using:ValidatableBindableBaseApp.Views"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:Mvvm="using:Prism.Windows.Mvvm"
    Mvvm:ViewModelLocator.AutoWireViewModel="True"
    mc:Ignorable="d"
    Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">

    <StackPanel>
        <TextBox Text="{x:Bind ViewModel.Message, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}"/>
        <TextBlock Text="{x:Bind ViewModel.Errors.Errors, Mode=OneWay}"/>
    </StackPanel>
</Page>

// MainPage.xaml.cs
using ValidatableBindableBaseApp.ViewModels;
using Windows.UI.Xaml.Controls;

// 空白ページの項目テンプレートについては、https://go.microsoft.com/fwlink/?LinkId=234238 を参照してください

namespace ValidatableBindableBaseApp.Views
{
    /// <summary>
    /// それ自体で使用できる空白ページまたはフレーム内に移動できる空白ページ。
    /// </summary>
    public sealed partial class MainPage : Page
    {
        public MainPageViewModel ViewModel => this.DataContext as MainPageViewModel;
        public MainPage()
        {
            this.InitializeComponent();
        }
    }
}

###試したこと
ViewModel.Errors.Errorsだと、System.Collections.Generic.Dictionary2[System.String.System.Collections.ObjectModel.ReadOnlyCollection1[System.String]]と表示されます。

補足情報（FW/ツールのバージョンなど）

VisualStudio 2019 community
Prism.Unity 6.3.0

Answer 1

→ Prism for WinRTのValidatableBindableBase

こちらのサンプルでErrorsからの値取り出しについて説明されてます。

ストアアプリ内での利用方法

このValidatableBindableBaseクラスは、TextBoxなどの入力系コントロールとValidatableBindableBaseを継承したクラスのプロパティをバインドすることが想定されています。そして、Errors[プロパティ名]をTextBlockなどにバインドしてConverterなどを利用して、IReadOnlyCollection<string>から最初の1つを取り出すようにします。コンバータのコード例を以下に示します

実際のコードや使い方はリンク先から確認してください。

今回の例の場合はまずリンク先で説明されている ErrorConverter をプロジェクト内に作成し、その上で Page.Resources に ErrorConverter を配置します。次にTextBlock.Textへのバインディングを MessageプロパティのErrorsを取り出して表示するように修正します。

<Page
    x:Class="ValidatableBindableBaseApp.Views.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="using:ValidatableBindableBaseApp.Views"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:Mvvm="using:Prism.Windows.Mvvm"
    xmlns:converters="using:<コンバーターの名前空間>"
    Mvvm:ViewModelLocator.AutoWireViewModel="True"
    mc:Ignorable="d"
    Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">

    <!-- StaticResource から利用できるようにする -->
    <Page.Rosources>
        <converters:ErrorConverter x:Key="ErrorConverter" />
    </Page.Rosources>

    <StackPanel>
        <TextBox Text="{x:Bind ViewModel.Message, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}"/>
        
        <!-- MessageプロパティのErrorをバインドする。ErrorConverterによってエラーが一つだけ返される。 -->
        <TextBlock Text="{x:Bind ViewModel.Errors[Message], Converter={StaticResource ErrorConverter}}" />
    </StackPanel>
</Page>

---

また、本件とは別に気になったところがありまして、

Mvvm:ViewModelLocator.AutoWireViewModel="True"としているのに {x:Bind ViewModel.*}を指定するのは、惜しいPrismの使い方かなと思うので、

<Page
    x:Class="ValidatableBindableBaseApp.Views.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="using:ValidatableBindableBaseApp.Views"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    xmlns:Mvvm="using:Prism.Windows.Mvvm"
    xmlns:converters="using:<コンバーターの名前空間>"
    Mvvm:ViewModelLocator.AutoWireViewModel="True"
    mc:Ignorable="d"
    Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">

    <Page.Rosources>
        <converters:ErrorConverter x:Key="ErrorConverter" />
    </Page.Rosources>

    <StackPanel>
        <!-- ViewModelLocator.AutoWireViewModelによってDataContextにMainPageViewModelが入っているはずなのでBindingをできるはず-->
        <TextBox Text="{Binding Message, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}"/>
        <TextBlock Text="{Binding Errors[Message], Converter={StaticResource ErrorConverter}}" />
    </StackPanel>
</Page>

こうすることでわざわざコードビハインドにViewModelを定義しなくても済むようになるかと思います。

x:Bindは要素のリピートが掛かって大量処理が必要な部分でこそ使うべきと思いますが、ページなど量より複雑さが深くなる場面では単純なBindingの指定にして、Xamlの見通しをよくした状態を保つほうが良いのかなと思います。ご参考までに。

Comments

[zin123]

返信が遅くなってしまい申し訳ありません。

サンプルを見て実装したところ、Bindingを使う方法では、エラーメッセージを表示させることができました。本当にありがとうございました。

しかし、x:Bindを使用した場合、
Invalid binding path 'ViewModel.Errors[Message]': Syntax error at symbol 'Message'
型'BindableValidator'はコレクションではありません
とエラーが出てしまいます。

[tor4kichi]

表示できたようでよかったです。

x:Bindは個人的にあまり使いこんでないので手助けできそうにありませんが、Xaml側ではなくViewModel側でErrors[Message] を解決できれば回避できたりしないかなと。

[zin123]

返信ありがとうございます。
x:Bindについてもう少し調べてみます。
ありがとうございました。