添付プロパティの作成

(2017/05/17 14:04:55 created.)

(2017/05/24 17:03:12 modified.)

添付ビヘイビアを作成するためには、独自の添付プロパティを作成する必要があります。ここでは、SampleBehavior という名前のクラスを定義し、その中に添付プロパティを作成します。

作成した添付ビヘイビアは XAML 上で使用する View の要素となるので、作成するソースは Views フォルダの中にまとめておくとわかりやすくなります。

添付プロパティを定義するには、DependencyProperty.RegisterAttached() メソッドを使用します。例えば bool 型で IsEnabled という名前の添付プロパティは次のように記述することで定義できます。

SampleBehavior.cs

```
namespace Tips_Behavior.Views.Behaviors
```
```
{
```
```
    using System.Windows;
```
```
 
```
```
    /// <summary>
```

    /// サンプルのビヘイビアを表します。

```
    /// </summary>
```
```
    public class SampleBehavior
```
```
    {
```
```
        /// <summary>
```

        /// IsEnabled 添付プロパティの定義

```
        /// </summary>
```

        public static readonly DependencyProperty IsEnabledProperty = DependencyProperty.RegisterAttached("IsEnabled", typeof(bool), typeof(SampleBehavior), new PropertyMetadata(false, OnIsEnabledPropertyChanged));

```
 
```
```
        /// <summary>
```

        /// IsEnabled 添付プロパティを取得します。

```
        /// </summary>
```

        /// <param name="target">対象とする DependencyObject を指定します。</param>

        /// <returns>取得した値を返します。</returns>

        public static bool GetIsEnabled(DependencyObject target)

```
        {
```

            return (bool)target.GetValue(IsEnabledProperty);

```
        }
```
```
 
```
```
        /// <summary>
```

        /// IsEnabled 添付プロパティを設定します。

```
        /// </summary>
```

        /// <param name="target">対象とする DependencyObject を指定します。</param>

        /// <param name="value">設定する値を指定します。</param>

        public static void SetIsEnabled(DependencyObject target, bool value)

```
        {
```

            target.SetValue(IsEnabledProperty, value);

```
        }
```
```
 
```
```
        /// <summary>
```

        /// IsEnabled 添付プロパティ変更イベントハンドラ

```
        /// </summary>
```

        /// <param name="sender">イベント発行元</param>

        /// <param name="e">イベント引数</param>

        private static void OnIsEnabledPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs e)

```
        {
```
```
        }
```
```
    }
```
```
}
```

13 行目で IsEnabled 添付プロパティを定義しています。変数名は任意で構いませんが、可読性を考慮して、プロパティ名に "Property" を付加した IsEnabledProeprty などといった名前にすることが一般的です。 RegisterAttached() メソッドの第 1 引数にプロパティ名 "IsEnabled" を与えます。

第 2 引数にはプロパティの型を System.Type クラスで指定します。ここでは bool 型のプロパティを定義したいので、typeof(bool) を指定しています。

第 3 引数には、このプロパティがどのクラスに属するのかを System.Type クラスで指定します。ここでは SampleBehavior クラスを指定したので、追加した IsEnabled 添付プロパティは、SampleBehavior.IsEnabled として認識されるようになります。

第 4 引数以降は特に指定しなくてもプロパティ定義としては成立しますが、このプロパティの既定値や、値が変化したときのコールバックなどが指定でき、ビヘイビアを使用するためにはこの部分が重要になるので、ここでは FrameworkPropertyMetadata クラスを第 4 引数として指定しています。

FrameworkPropertyMetadata クラスのコンストラクタに対する第 1 引数に IsEnabled プロパティの既定値、第 2 引数にプロパティ値変更時のコールバックメソッドを指定しています。

添付プロパティを取得したり設定したりするためには、規定された名前のメソッドを用意する必要があります。取得するためのメソッドはプロパティ名の頭に "Get" を付けた名前で、ここでは GetIsEnabled という名前になります。設定するためのメソッドはプロパティ名の頭に "Set" を付けた名前で、ここでは SetIsEnabled という名前になります。それぞれのメソッドを 15～33 行目のように定義します。

以上で添付プロパティの定義は完了です。試しに XAML 上で添付プロパティを設定してみましょう。

MainView.xaml

<Window x:Class="Tips_Behavior.Views.MainView"

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

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

        xmlns:b="clr-namespace:Tips_Behavior.Views.Behaviors"

        Title="MainView" Height="120" Width="300">

```
    <StackPanel>
```

        <Button Content="Click me." b:SampleBehavior.IsEnabled="False" />

        <Button Content="Click me." b:SampleBehavior.IsEnabled="True" />

        <TextBlock Text="Click me." b:SampleBehavior.IsEnabled="True" />

```
    </StackPanel>
```
```
</Window>
```

作成した IsEnabled 添付プロパティは SampleBehavior クラスに属しているので、このクラスが属する名前空間を 4 行目のように定義する必要があります。このエイリアスを用いて、7～9 行目のように IsEnabled 添付プロパティを任意のコントロールに添付することができます。

ここまでのサンプルコードでは、IsEnabled 添付プロパティを作成しただけなので、このプロパティが設定されたコントロールには特に変化はありません。