5.2 UI を作成する
5.3.2 添付プロパティの作成
これまでに Canvas.Left や Grid.Row などの添付プロパティが登場してきました。これらは、自分自身に与えるプロ パティではなく、異なるコントロールに対して添付するためのプロパティであり、Canvas パネルや Grid パネルはこれら の添付プロパティを読み込んで子要素の配置をおこなっていました。
つまり、添付プロパティとは既存のコントロールにプロパティを添付することです。このような添付プロパティを自作す ることができます。ここでは MenuItem コントロールに ViewModel のコールバックメソッドをデータバインディングで きるように Action<bool, string> 型の添付プロパティを作成してみましょう。
まず、CommonDialogBehavior クラスを作成します。View に関する操作なので、ソリューションエクスプローラーの
Views フォルダに Behaviors フォルダを作成し、そこにファイルを追加します。このクラスを使って添付プロパティを説
明しますが、その後これを利用して添付ビヘイビアとするため、フォルダ名を Behaviors としています。
図 5.9：ビヘイビアを記述するためのクラスを追加する
添付プロパティを定義するには、DependencyProperty クラスを用いて次のように記述します。
コード 5.8：Callback 添付プロパティを持つ CommonDialogBehavior クラス CommonDialogBehavior.cs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
16 17 18 19 20
namespace YKWpfIntroduction.Practices.Views.Behaviors {
using System;
using System.Windows;
/// <summary>
/// コモンダイアログに関するビヘイビアを表します。
/// </summary>
internal class CommonDialogBehavior {
#region Callback 添付プロパティ
/// <summary>
/// Action<bool, string> 型の Callback 添付プロパティを定義します。
/// </summary>
public static readonly DependencyProperty CallbackProperty =
DependencyProperty.RegisterAttached("Callback", typeof(Action<bool, string>), typeof(CommonDialogBehavior), new PropertyMetadata(null));
/// <summary>
/// Callback 添付プロパティを取得します。
/// </summary>
/// <param name="target">対象とする DependencyObject を指定します。</param>
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
/// <returns>取得した値を返します。</returns>
public static Action<bool, string> GetCallback(DependencyObject target) {
return (Action<bool, string>)target.GetValue(CallbackProperty);
}
/// <summary>
/// Callback 添付プロパティを設定します。
/// </summary>
/// <param name="target">対象とする DependencyObject を指定します。</param>
/// <param name="value">設定する値を指定します。</param>
public static void SetCallback(DependencyObject target, Action<bool, string> value) {
target.SetValue(CallbackProperty, value);
}
#endregion Callback 添付プロパティ
} }
まず 15 行目で CallbackProperty という名前の変数を定義しています。この変数が添付プロパティを表しており、
DependencyProperty.RegisterAttached() メソッドでどのような添付プロパティかを定義しています。
DependencyProperty.RegisterAttached() メソッドの第 1 引数は添付プロパティの名前を指定します。第 2 引数は 添付プロパティの型、第 3 引数はこの添付プロパティを所有するクラスの型を指定します。第 4 引数には添付プロパティ に対するメタ情報を指定します。ここでは ProeprtyMetadata クラスを使用して、既定値が null であるというメタ情報 を指定しています。
さらに、添付プロパティを定義する場合、Get○○() メソッドと Set○○() メソッドを必ず定義する必要があります。
○○の部分は必ず添付プロパティ名と同一でなければなりません。ここでは添付プロパティ名を "Callback" としている ため、GetCallback() メソッドと SetCallback() メソッドになっています。
一方で、Action<bool, string> 型のプロパティを MainViewModel に準備します。これは後ほどダイアログのコール バックメソッドとして利用するため、DialogCallback という名前で次のように定義します。
コード 5.9：MainViewModel クラスに DialogCallback プロパティを追加する MainViewModel.cs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
namespace YKWpfIntroduction.Practices.ViewModels {
using System;
/// <summary>
/// MainView ウィンドウに対するデータコンテキストを表します。
/// </summary>
internal class MainViewModel : NotificationObject {
private DelegateCommand _openFileCommand;
/// <summary>
/// ファイルを開くコマンドを取得します。
/// </summary>
public DelegateCommand OpenFileCommand {
get {
return this._openFileCommand ?? (this._openFileCommand = new DelegateCommand(
_ =>
{
System.Diagnostics.Debug.WriteLine("ファイルを開きます。");
}));
} }
private Action<bool, string> _dialogCallback;
27 28 29 30 31 32 33 34 35 36
/// <summary>
/// ダイアログに対するコールバックを取得します。
/// </summary>
public Action<bool, string> DialogCallback {
get { return this._dialogCallback; }
private set { SetProperty(ref this._dialogCallback, value); } }
} }
準備が整ったので、「開く」メニューを表す MenuItem コントロールに用意した添付プロパティを実装しましょう。
コード 5.10：作成した添付プロパティを使用する
MainView.xaml 1
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
<Window x:Class="YKWpfIntroduction.Practices.Views.MainView"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:b="clr-namespace:YKWpfIntroduction.Practices.Views.Behaviors"
Title="MainView" Height="300" Width="300">
<DockPanel>
<Menu DockPanel.Dock="Top">
<MenuItem Header="ファイル (_F)">
<MenuItem Header="開く(_O)"
Command="{Binding OpenFileCommand}"
b:CommonDialogBehavior.Callback="{Binding DialogCallback}"
/>
</MenuItem>
<MenuItem Header="ヘルプ (_H)" />
</Menu>
<StatusBar DockPanel.Dock="Bottom">
</StatusBar>
<Grid Background="MediumSeaGreen">
</Grid>
</DockPanel>
</Window>
11 行目で CommonDialogBehavior.Callback 添付プロパティに対して MainViewModel クラスの DialogCallback プロパティをデータバインディングしています。ただし、CommonDialogBehavior クラスは .NET Framework 標準のクラ スではないため、アクセスするために名前空間のエイリアスを定義する必要があります。これが 4 行目の "xmlns:b" か ら始まる記述で、YKWpfIntroduction.Practices.Views.Behaviors 名前空間のエイリアスを "b" として定義していま す。こうすることで "b:" で記述すると YKWpfIntroduction.Practices.Views.Behaviors 名前空間に属するクラスに アクセスできるようになります。11 行目でも "b:CommonDialogBehavior" というように記述しています。
こ の 時 点 で ア プ リ ケ ー シ ョ ン を 実 行 し て も 特 に 動 作 は 変 わ り ま せ ん 。 と い う の は MainViewModel ク ラ ス の
DialogCallback プロパティは何も指定していないので中身は null ですし、そもそも作成した添付プロパティを参照す
る相手がいないからです。
次にこの添付プロパティを利用してコントロールの振る舞いを決定する添付ビヘイビアを作成します。