【WPF】Viewの子孫要素をC#コードから取得する方法

こんにちは、働くC#プログラマーのさんさめです。

前回、C#コードから
VisualTreeの祖先要素を取得する方法を書きました。

今回は逆に、
VisualTreeの子孫要素を取得する方法を解説します。

祖先要素を取得するAPIと同様に、
VisualTreeHelperクラスにGetChild
というメソッドがあるのですが…

さんさめ

Helperを名乗る割に使いにくいんだってば

さらに残念なことに
GetChildは「何番目の子孫要素を取得するか」
を引数に要求するため、
使うときの面倒さがGetParentの比ではありません。

というわけで、前回に引き続き、
さんさめが実際に働く上で用いている
GetChildのラッパー実装を紹介します。

直近の子孫要素を取得するラッパーメソッド
1. 子要素を辿る場合は実行タイミングに注意が必要
VisualTreeの子孫要素を辿るヘルパーメソッドの実際の使用例
VisualTreeの子孫要素を列挙するメソッドはあんまり使わない
まとめ
関連記事

直近の子孫要素を取得するラッパーメソッド

さて、やはりというかなんというか、
子孫要素を辿るときも、
「型を指定」して「最初に見つかるもの」
が欲しいことが大半です。

この傾向は祖先要素の取得よりもさらに顕著です。

VisualTreeの子孫要素を取得したい時は、
ほとんどの場合、
「Templateになっているものにアクセスして
ごにょごにょしたい」ケースだからですね。

ListBoxに内包されているScrollViewer
DataGridに内包されている表左上のButton
DataGridに内包されているDataGridColumnHeadersPresenter
DataGridに内包されている…

といったものです。

さんさめ

ほとんどDataGridやないかい

他にもWPFに慣れてくると思い始める
「こいつがこう動いてくれればなぁ…」
というケースでは大抵使えます。

というわけでコードサンプルです。

public static class VisualTreeHelperWrapper
{
    public static T FindDescendant<T>(this DependencyObject depObj)
        where T : DependencyObject
    {
        if (depObj == null) { return null; }

        for (var i = 0; i < VisualTreeHelper.GetChildrenCount(depObj); i++)
        {
            var child = VisualTreeHelper.GetChild(depObj, i);

            var result = (child as T) ?? FindDescendant<T>(child);
            if (result != null) { return result; }
        }
        return null;
    }
}

使用例は以下の通りです。