このエントリは、M-V-VMパターンについてのエントリを訳してみる試みの四本目です。今回は添付ビヘイビアというテクニックを解説した、CodeProject: Introduction to Attached Behaviors in WPFという記事を訳してみました。著者はMSDN MagazineのWPF のための MODEL-VIEW-VIEWMODEL (MVVM) デザイン パターンという記事も書かれたJosh Smithさん。Crack.NETの作者の方でもあります。

-訳ここから-

AttachedBehavior.jpg

導入 Introduction

この記事は添付ビヘイビアが何であるか、WPFアプリケーションでどう実装できるのかを解説します。この記事の読者はWPF、XAML、添付プロパティそしてModel-View-ViewModel(MVVM)パターンに多少親しんでいる必要があります。私の‘Simplifying the WPF TreeView by Using the ViewModel Pattern’という記事も読まれることを強くお勧めします。なぜなら、ここでの題材はその記事での題材の延長だからです。

This article explains what an attached behavior is, and how you can implement them in a WPF application. Readers of this article should be somewhat familiar with WPF, XAML, attached properties, and the Model-View-ViewModel (MVVM) pattern. I highly recommend that you also read my ‘Simplifying the WPF TreeView by Using the ViewModel Pattern’ article, because the material here is an extension of the material presented in it.

背景 Background

2008年の五月頃、私は‘Simplifying the WPF TreeView by Using the ViewModel Pattern’という記事を公開しました。その記事はMVVMパターンにフォーカスしていました。今朝、私は起きるとPascal Binggeliという方が記事のコメント欄に素晴らしい質問をされているのに気づきました。

Back in May of 2008, I published an article called ‘Simplifying the WPF TreeView by Using the ViewModel Pattern’. That article focused on the MVVM pattern. This morning I woke up to find that a fellow by the name of Pascal Binggeli had asked an excellent question on that article’s message board.

Pascalは、TreeViewと連携するViewModelオブジェクトがTreeViewItemを選択したときにどうやってそれをTreeViewコントロールの表示範囲にスクロールさせればよいかを知りたがっていました。この問いは十分にシンプルに見えますが、検討を重ねると、最初に想像していた程容易ではないのがわかるでしょう。目標、そして問題は、MVVMパターンの原則が破られないよう、選択されたTreeViewItemBringIntoView()メソッドを呼ぶコードを配置する適切な場所を見つけることです。

Pascal wanted to know how to scroll a TreeViewItem into the viewable area of the TreeView control when its associated ViewModel object selects it. That seems simple enough, but upon further examination, it is not quite as straightforward as one might initially expect. The objective, and problem, is to find the proper place to put code that calls BringIntoView() on the selected TreeViewItem, such that the principles of the MVVM pattern are not violated.

例えば、ユーザーが、TreeView内の、ユーザーが決定した検索文字列にマッチするテキストを表示する項目を探す場合を考えてみてください。検索ロジックがマッチする項目を見つけた場合、マッチするViewModelオブジェクトはそのIsSelectedプロパティをtrueに設定します。すると、データバインディングの魔術によってそのViewModelオブジェクトと連携するTreeViewItemは選択状態になります(即ち、そのIsSelectedプロパティもtrueにセットされます)。しかしながら、そのTreeViewItemは必ずしも表示範囲内に来るという訳ではありません。これは、ユーザーは検索文字列に一致する項目を見ることが出来ないということを意味します。PascalはViewModelがそれが選択状態であるかを決定するときにTreeViewItemが見える範囲に来ることを望んでいました。

For example, suppose that the user searches through a TreeView for an item whose display text matches a user-defined search string. When the search logic finds a matching item, the matching ViewModel object will have its IsSelected property set to true. Then, via the magic of data binding, the TreeViewItem associated with that ViewModel object enters into the selected state (i.e. its IsSelected property is set to true, too). However, that TreeViewItem will not necessarily be in view, which means the user will not see the item that matches their search string. Pascal wanted a TreeViewItem brought into view when the ViewModel determines that it is in the selected state.

ViewModelオブジェクトはTreeViewItemが存在するか、そしてそれにバインドされいるかについて感知しません。そのため、ViewModelオブジェクトにTreeViewItemを見える範囲に持ってこさせるのを望むのは筋違いです。この問題は今や、ViewModelがそれを選択状態においた時に、誰がTreeViewItemを見える範囲に持ってくる責任を負うのかという問題になりました。

The ViewModel objects have no idea that a TreeViewItem exists and is bound to them, so it does not make sense to expect the ViewModel objects to bring TreeViewItems into view. The question becomes, now, who is responsible for bringing a TreeViewItem into view when the ViewModel forces it to be selected?

ViewModelオブジェクトと視覚要素を連結するのは不自然さをもたらし、また、余計ですので、私達は確かにそのコードをViewModelに入れたくはありません。私達はそのコードをViewModelにバインドされたTreeViewのコードビハインドのあらゆる場所に入れたくありません。なぜなら、そうすることは、我々が初めにViewModelを使うことによって避けた問題のいくつかを再び引き起こすからです。私達は選択された時に自分自身を見える範囲に持っていくビルトインサポートを持ったTreeViewItemサブクラスを作成することは出来ますが、WPFの世界において、それは疑いようもなく、簡単な問題に対する重量級の解決策です。

We certainly do not want to put that code into the ViewModel because it introduces an artificial, and unnecessary, coupling between a ViewModel object and a visual element. We do not want to put that code in the code-behind of every place a TreeView is bound to a ViewModel, because it reintroduces some of the problems that we avoid by using a ViewModel in the first place. We could create a TreeViewItem subclass that has built-in support for bringing itself into view when selected, but, in the WPF world, that is definitely a heavy-handed solution to a lightweight problem.

私達は、この問題を簡単で再利用可能なやり方でどのようにエレガントに解決することが出来るでしょうか?

How can we elegantly solve this problem in a lightweight and reusable way?

添付ビヘイビア Attached Behaviors

今まで説明した問題の解決策は添付ビヘイビアを使うことです。オブジェクトに対する添付ビヘイビアはオブジェクトに何かそれ自身ではしようとしないことをさせることを単に意味しています。ここに私が‘Working with CheckBoxes in the WPF TreeView’という記事で書いた添付ビヘイビアの説明があります。

添付プロパティを公開するクラスから要素へのアクセスを得ることが出来るように、添付プロパティを要素にセットするというアイデアです。クラスが要素へのアクセスを得さえすれば、クラスは要素のイベントをフックすることができ、それらのイベント発生への反応において要素に普段はしないことをさせることが出来ます。それはサブクラスを作成して使うのに代わる非常に便利な選択肢であり、また非常にXAMLフレンドリでもあります。

あの記事では、デモアプリケーションは添付ビヘイビアを複雑な方法で使っていますが、この記事では、私達は添付ビヘイビアの使い方をシンプルに保ちました。背景と理論の話はこのぐらいにして、我らが友、Pascalが提示した問題を解決する添付ビヘイビアの作り方をみていきましょう。

The solution to the problem explained above is to use an attached behavior. Attaching a behavior to an object simply means making the object do something that it would not do on its own. Here is the explanation of attached behaviors that I wrote in my ‘Working with CheckBoxes in the WPF TreeView’ article:

The idea is that you set an attached property on an element so that you can gain access to the element from the class that exposes the attached property. Once that class has access to the element, it can hook events on it and, in response to those events firing, make the element do things that it normally would not do. It is a very convenient alternative to creating and using subclasses, and is very XAML-friendly.

In that article, the demo application uses attached behaviors in complicated ways, but in this article, we will keep it simple. Enough with the background and theory, let’s see how to create an attached behavior that solves the problem posed by our friend Pascal.

デモンストレーション Demonstration

この記事のデモアプリは、このページの頭でダウンロード可能ですが、‘Simplifying the WPF TreeView by Using the ViewModel Pattern’の記事で使用した検索デモを使っています。私はTreeViewにより多くの項目を追加したり、フォントサイズを大きくしたり、添付ビヘイビアを加えるなどの幾つかの変更をしました。添付ビヘイビアはTreeViewItemBehaviorという新しい静的クラス内に存在します。そのクラスは、TreeViewItemにセット出来るIsBroughtIntoViewWhenSelectedというBoolean型の添付ビヘイビアを公開します。これがTreeViewItemBehaviorクラスです:

This article’s demo app, which is available for download at the top of this page, uses the Text Search demo provided by the ‘Simplifying the WPF TreeView by Using the ViewModel Pattern’ article. I made a few changes, such as adding more items to the TreeView, increasing the font size, and adding an attached behavior. The attached behavior is in a new static class called TreeViewItemBehavior. That class exposes a Boolean attached property that can be set on a TreeViewItem, called IsBroughtIntoViewWhenSelected. Here is the TreeViewItemBehavior class:

 /// <summary>
/// Exposes attached behaviors that can be
/// applied to TreeViewItem objects.
/// </summary>
public static class TreeViewItemBehavior
{
    #region IsBroughtIntoViewWhenSelected

    public static bool GetIsBroughtIntoViewWhenSelected(TreeViewItem treeViewItem)
    {
        return (bool)treeViewItem.GetValue(IsBroughtIntoViewWhenSelectedProperty);
    }

    public static void SetIsBroughtIntoViewWhenSelected(
      TreeViewItem treeViewItem, bool value)
    {
        treeViewItem.SetValue(IsBroughtIntoViewWhenSelectedProperty, value);
    }

    public static readonly DependencyProperty IsBroughtIntoViewWhenSelectedProperty =
        DependencyProperty.RegisterAttached(
        "IsBroughtIntoViewWhenSelected",
        typeof(bool),
        typeof(TreeViewItemBehavior),
        new UIPropertyMetadata(false, OnIsBroughtIntoViewWhenSelectedChanged));

    static void OnIsBroughtIntoViewWhenSelectedChanged(
      DependencyObject depObj, DependencyPropertyChangedEventArgs e)
    {
        TreeViewItem item = depObj as TreeViewItem;
        if (item == null)
            return;

        if (e.NewValue is bool == false)
            return;

        if ((bool)e.NewValue)
            item.Selected += OnTreeViewItemSelected;
        else
            item.Selected -= OnTreeViewItemSelected;
    }

    static void OnTreeViewItemSelected(object sender, RoutedEventArgs e)
    {
        // Only react to the Selected event raised by the TreeViewItem
        // whose IsSelected property was modified.  Ignore all ancestors
        // who are merely reporting that a descendant's Selected fired.
        if (!Object.ReferenceEquals(sender, e.OriginalSource))
            return;

        TreeViewItem item = e.OriginalSource as TreeViewItem;
        if (item != null)
            item.BringIntoView();
    }

    #endregion // IsBroughtIntoViewWhenSelected
}

上の添付ビヘイビアは基本的にTreeViewItemSelectedプロパティをフックし、イベントが発生した時に項目のBringIntoView()を呼ぶ手の込んだ方法です。このパズルの最後のピースはTreeViewItemBehaviorクラスがTreeViewの各TreeViewItemへの参照を得る方法です。我々は以下のようにSetterTreeView内のTreeViewItemの各項目に適用されたStyleに加えることで実現しました:

The attached behavior seen above is basically just a fancy way of hooking the Selected property of a TreeViewItem and, when the event is raised, calling BringIntoView() on the item. The final piece of this puzzle is seeing how the TreeViewItemBehavior class gets a reference to every TreeViewItem in the TreeView. We accomplish that by adding a Setter to the Style applied to every item in the TreeView, as seen below:

 <TreeView.ItemContainerStyle>
  <Style TargetType="{x:Type TreeViewItem}">
    <!--
    This Setter applies an attached behavior to all TreeViewItems.
    -->
    <Setter 
      Property="local:TreeViewItemBehavior.IsBroughtIntoViewWhenSelected" 
      Value="True" 
      />

    <!-- 
    These Setters bind a TreeViewItem to a PersonViewModel.
    -->
    <Setter Property="IsExpanded" Value="{Binding IsExpanded, Mode=TwoWay}" />
    <Setter Property="IsSelected" Value="{Binding IsSelected, Mode=TwoWay}" />
    <Setter Property="FontWeight" Value="Normal" />
    <Style.Triggers>
      <Trigger Property="IsSelected" Value="True">
        <Setter Property="FontWeight" Value="Bold" />
      </Trigger>
    </Style.Triggers>
  </Style>
</TreeView.ItemContainerStyle>

デモアプリケーションが読み込まれると、検索語は自動的に「Y」という文字にセットされます。Findボタンを何度か押すと、そのたびに項目が選択されるのがわかるでしょう。その項目は「Y」を含んでおり、見える範囲にスクロールされます。選択された時に項目が見える範囲にスクロールされるということは添付ビヘイビアがうまく働いているということです。

When the demo application loads up, the search text will be set to the letter Y automatically. Click the Find button a few times, and you will see that each time an item is selected, it will contain the letter Y and will scroll into view. The fact that it scrolls into view upon being selected means that the attached behavior is working properly.

結論 Conclusion

オブジェクトのイベントをフックし、発生したときに何かをするのは、どれだけ想像力を働かせても、確かに飛躍的なイノベーションではありません。その意味で、添付ビヘイビアは同じことをするありきたりの方法に過ぎません。しかしながら、このテクニックの重要性は名前を持ったことであり、これはデザインパターンのもっとも重要な側面かもしれません。加えて、システムの別の部分を変更することなしに、添付ビヘイビアを作成し、どんな要素にも適用することが出来ます。添付ビヘイビアはPascal Binggeliが提起した問題、そして非常に多くの別の問題への綺麗な解決策です。添付ビヘイビアは道具箱に備えておくべき非常に便利な道具です。

Hooking an event on an object and doing something when it fires is certainly not a breakthrough innovation, by any stretch of the imagination. In that sense, attached behaviors are just another way to do the same old thing. However, the importance of this technique is that it has a name, which is probably the most important aspect of any design pattern. In addition, you can create attached behaviors and apply them to any element, without having to modify any other part of the system. It is a clean solution to the problem raised by Pascal Binggeli, and many, many other problems. It’s a very useful tool to have in your toolbox.

参考文献 References

The Attached Behavior Pattern – John Gossman

Simplifying the WPF TreeView by Using the ViewModel Pattern – Josh Smith

Working with CheckBoxes in the WPF TreeView – Josh Smith

改定履歴 Revision History

  • August 30, 2008 – Created the article

ライセンス License

この記事と、関連するソースコードやファイルはThe Code Project Open License (CPOL)の下でライセンスされています。

(訳注:和訳に際してJosh Smithさんから許可を頂いています。)

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

著者について About the Author

Joshはソフトウェア開発者です。C#とXAMLは彼の愛好する表現方法です。

彼はInfragisticsにおいてエクスペリエンスデザインアプリケーションエンジニアとして働いており、.NETのデスクトップ環境をより良き場所にする手助けをしています。

彼はJ.S. バッハの曲をピアノで演奏もします。

とりわけ、彼は彼の素晴らしいガールフレンドと共に過ごすことを愛しています。

Crack.NETという彼のランタイムデバッキング、スクリプティングツールをここから手に入れよう![^].

彼のWPF.JoshSmithライブラリをここからダウンロードしよう[^]

ここから彼のWPFブログをチェックすることが出来ます[^].

ここから彼のWPFツアーに参加することが出来ます[^].

Mole for Visual Studioという彼が手掛けたパワフルなデバッガビジュアライザをここからチェックできます[^].

彼のMicrosoft MVPプロフィールはここで見ることが出来ます[^].

Occupation: 
ソフトウェア開発者 (上級)

Company:

Infragistics, Inc.

Location:

United States アメリカ合衆国

Josh creates software. C# and XAML are his preferred modes of expression.

He works at Infragistics as an Experience Design Application Engineer, helping to make the .NET desktop world a better place.

He also plays the music of J.S. Bach on the piano.

Most of all, he loves being with his wonderful girlfriend.

Get his runtime debugging and scripting tool, called Crack.NET, right here[^].

Download his WPF.JoshSmith library here[^]

You can check out his WPF blog here[^].

You can take his guided tour of WPF here[^].

You can check out a powerful debugger visualizer he worked on called Mole for Visual Studio here[^].

His Microsoft MVP profile can be viewed here[^].

Occupation:

Software Developer (Senior)

Company:

Infragistics, Inc.

Location:

United States United States

Comments :2

how to download flash videos from websites 11-02-02 10:44:26 UTC

Interesting article i totally agree with other commenters. Keep writing

gucci バッグ アウトレット 13-07-21 16:53:11 UTC

M-V-VMパターンについての記事を訳してみた4 原題”Introduction to Attached Behaviors in WPF” – SharpLab.

Trackbacks : 5

Trackback URL for this entry
http://blog.sharplab.net/blog/2009/03/13/1856/trackback/

Listed below are links to weblogs that reference this entry

ピンバック from 添付ビヘイビア試してみた - SharpLab. 09-03-14 00:55:16 UTC

[…] ひとつ前のエントリでJosh Smithさんの添付プロパティの解説記事を訳したのですが、実際に自分でもコードを書いて試してみようということで、少し変えて、添付されたListBoxのItemsSourceが […]

ピンバック from Expression Blend 3のBehaviorサポート - SharpLab. 09-04-21 16:38:55 UTC

[…] さて、紹介された中で、特に自分が気になったのはExpression Blend 3によるBehaviorのサポート。Expression Blend3ではBehaviorがサポートされ、それはどうも添付ビヘイビアのことらしい…、というのはネットでちらちら聞いていたのですが、実際にBehaviorを使った開発のデモを見せて頂いて、動いているのを見ると非常に便利そうな印象を受けたので、早速自分でも試してみました。 […]

トラックバック from ケア用品 衛生用品ス お風呂用品 14-10-14 00:27:23 UTC

ケア用品 衛生用品ス お風呂用品…

M-V-VMパターンについての記事を訳してみた4 原題”Introduction to Attached Behaviors in WPF” – SharpLab….

トラックバック from עבודה בקנדה הגירה לקנדה 15-02-15 03:42:17 UTC

עבודה בקנדה הגירה לקנדה…

… עבודה בחו”ל – כיום עבודה בקנדה הגירה לקנדה בן אדם והמשכורת שאותו בן אדם יכול לעבוד הברית?לפני כל מחפש עבודה בחול. שתי האופציות האחרות מיועדות לאלו המחפשים עבודה באירופה, לא מכירות היא עבודה ל… M-V-VMパターンについての記事を訳してみた4 原題&quot;Introduction to…

トラックバック from How To Get A Woman To Take Her Shirt Off 15-07-06 06:02:07 UTC

How To Get A Woman To Take Her Shirt Off…

… – When you engage her by meeting for how to get a woman to take her shirt off and progressing to fun stuff like dishes, laundry and meal preparation. Check out my site and discove… M-V-VMパターンについての記事を訳してみた4 原題&quot;Introduction to … ……