web-dev-qa-db-ja.com

タイプ別にWPFウィンドウのすべてのコントロールを検索

私はタイプごとにウィンドウ上のすべてのコントロールを見つける方法を探しています、

例:すべてのTextBoxesの検索、特定のインターフェイスを実装するすべてのコントロールの検索など。

204

これはトリックを行う必要があります

public static IEnumerable<T> FindVisualChildren<T>(DependencyObject depObj) where T : DependencyObject
{
    if (depObj != null)
    {
        for (int i = 0; i < VisualTreeHelper.GetChildrenCount(depObj); i++)
        {
            DependencyObject child = VisualTreeHelper.GetChild(depObj, i);
            if (child != null && child is T)
            {
                yield return (T)child;
            }

            foreach (T childOfChild in FindVisualChildren<T>(child))
            {
                yield return childOfChild;
            }
        }
    }
}

その後、次のようにコントロールを列挙します

foreach (TextBlock tb in FindVisualChildren<TextBlock>(window))
{
    // do something with tb here
}
403
Bryce Kahle

これが最も簡単な方法です。

IEnumerable<myType> collection = control.Children.OfType<myType>(); 

ここで、controlはウィンドウのルート要素です。

60
Joel

@Mathias Lykkegaard Lorenzenの提案に従い、LogicalTreeHelperを使用するように、@ Bryce Kahleの回答を採用しました。

うまくいくようです。 ;)

    public static IEnumerable<T> FindLogicalChildren<T> ( DependencyObject depObj ) where T : DependencyObject {
        if( depObj != null ) {
            foreach( object rawChild in LogicalTreeHelper.GetChildren( depObj ) ){
                if( rawChild is DependencyObject ) {
                    DependencyObject child = (DependencyObject)rawChild;
                    if( child is T ) {
                        yield return (T)child;
                    }

                    foreach( T childOfChild in FindLogicalChildren<T>( child ) ) {
                        yield return childOfChild;
                    }
                }
            }
        }
    }

(@Benjamin Berryと@David Rがそれぞれ言及しているように、GroupBox内のタブコントロールまたはグリッドはまだチェックされません。)(また、@ noonandの提案に従い、冗長な子を削除しました!= null)

19
Simon F

ヘルパークラスVisualTreeHelperまたはLogicalTreeHelperを使用してください。どちらの tree に関心があるかによって異なります。どちらも、要素の子を取得するためのメソッドを提供します(構文は少し異なります)。私はしばしば特定のタイプの最初の出現を見つけるためにこれらのクラスを使用しますが、簡単に修正してそのタイプのすべてのオブジェクトを見つけることができます:

public static DependencyObject FindInVisualTreeDown(DependencyObject obj, Type type)
{
    if (obj != null)
    {
        if (obj.GetType() == type)
        {
            return obj;
        }

        for (int i = 0; i < VisualTreeHelper.GetChildrenCount(obj); i++)
        {
            DependencyObject childReturn = FindInVisualTreeDown(VisualTreeHelper.GetChild(obj, i), type);
            if (childReturn != null)
            {
                return childReturn;
            }
        }
    }

    return null;
}
11
Oskar

上記のいくつかの例で使用されているVisualTreeHelper.GetChildrenCount(depObj);という行は、特にGroupBoxにグリッドが含まれ、Gridに子要素が含まれる場合、GroupBoxのゼロ以外のカウントを返しません。これは、GroupBoxに複数の子を含めることが許可されておらず、これがそのContentプロパティに格納されているためであると考えています。 GroupBox.Childrenタイプのプロパティはありません。私はこれを非常に効率的に実行しなかったと確信していますが、このチェーンの最初の「FindVisualChildren」の例を次のように変更しました。

    public IEnumerable<T> FindVisualChildren<T>(DependencyObject depObj) where T : DependencyObject 
    { 
        if (depObj != null) 
        {
            int depObjCount = VisualTreeHelper.GetChildrenCount(depObj); 
            for (int i = 0; i <depObjCount; i++) 
            { 
                DependencyObject child = VisualTreeHelper.GetChild(depObj, i); 
                if (child != null && child is T) 
                { 
                    yield return (T)child; 
                }

                if (child is GroupBox)
                {
                    GroupBox gb = child as GroupBox;
                    Object gpchild = gb.Content;
                    if (gpchild is T)
                    {
                        yield return (T)child; 
                        child = gpchild as T;
                    }
                }

                foreach (T childOfChild in FindVisualChildren<T>(child)) 
                { 
                    yield return childOfChild; 
                } 
            }
        }
    } 
9
David R

再帰への小さな変更。たとえば、タブコントロールの子タブコントロールを見つけることができます。

    public static DependencyObject FindInVisualTreeDown(DependencyObject obj, Type type)
    {
        if (obj != null)
        {
            for (int i = 0; i < VisualTreeHelper.GetChildrenCount(obj); i++)
            {
                DependencyObject child = VisualTreeHelper.GetChild(obj, i);

                if (child.GetType() == type)
                {
                    return child;
                }

                DependencyObject childReturn = FindInVisualTreeDown(child, type);
                if (childReturn != null)
                {
                    return childReturn;
                }
            }
        }

        return null;
    }
4
Benjamin Berry

特定のタイプのすべての子のリストを取得するには、次を使用できます。

private static IEnumerable<DependencyObject> FindInVisualTreeDown(DependencyObject obj, Type type)
{
    if (obj != null)
    {
        if (obj.GetType() == type)
        {
            yield return obj;
        }

        for (var i = 0; i < VisualTreeHelper.GetChildrenCount(obj); i++)
        {
            foreach (var child in FindInVisualTreeDown(VisualTreeHelper.GetChild(obj, i), type))
            {
                if (child != null)
                {
                    yield return child;
                }
            }
        }
    }

    yield break;
}
4
Michael

そして、これはそれが上向きに働く方法です

    private T FindParent<T>(DependencyObject item, Type StopAt) where T : class
    {
        if (item is T)
        {
            return item as T;
        }
        else
        {
            DependencyObject _parent = VisualTreeHelper.GetParent(item);
            if (_parent == null)
            {
                return default(T);
            }
            else
            {
                Type _type = _parent.GetType();
                if (StopAt != null)
                {
                    if ((_type.IsSubclassOf(StopAt) == true) || (_type == StopAt))
                    {
                        return null;
                    }
                }

                if ((_type.IsSubclassOf(typeof(T)) == true) || (_type == typeof(T)))
                {
                    return _parent as T;
                }
                else
                {
                    return FindParent<T>(_parent, StopAt);
                }
            }
        }
    }
2
Andreas

VisualTreeHelperの使用は、VisualまたはVisual3Dから派生したコントロールでのみ機能することに注意してください。他の要素(TextBlock、FlowDocumentなど)も検査する必要がある場合、VisualTreeHelperを使用すると例外がスローされます。

必要に応じて論理ツリーにフォールバックする代替手段を次に示します。

http://www.hardcodet.net/2009/06/finding-elements-in-wpf-tree-both-ways

2
Philipp

ジェネリック構文を使用した、もう1つのコンパクトバージョンを次に示します。

    public static IEnumerable<T> FindLogicalChildren<T>(DependencyObject obj) where T : DependencyObject
    {
        if (obj != null) {
            if (obj is T)
                yield return obj as T;

            foreach (DependencyObject child in LogicalTreeHelper.GetChildren(obj).OfType<DependencyObject>()) 
                foreach (T c in FindLogicalChildren<T>(child)) 
                    yield return c;
        }
    }
2
user1656671

何らかの理由で、ここに投稿された回答のどれも、メインウィンドウの特定のコントロールに含まれる特定のタイプのすべてのコントロールを取得するのに役立ちませんでした。 1つのメニューですべてのメニュー項目を見つけて、それらを繰り返す必要がありました。それらはすべてメニューの直接の子孫ではなかったので、上記のコードのいずれかを使用して、それらの最初の子孫だけを収集することができました。この拡張方法は、ここからずっと読み続ける人にとっての問題に対する私の解決策です。

public static void FindVisualChildren<T>(this ICollection<T> children, DependencyObject depObj) where T : DependencyObject
    {
        if (depObj != null)
        {
            var brethren = LogicalTreeHelper.GetChildren(depObj);
            var brethrenOfType = LogicalTreeHelper.GetChildren(depObj).OfType<T>();
            foreach (var childOfType in brethrenOfType)
            {
                children.Add(childOfType);
            }

            foreach (var rawChild in brethren)
            {
                if (rawChild is DependencyObject)
                {
                    var child = rawChild as DependencyObject;
                    FindVisualChildren<T>(children, child);
                }
            }
        }
    }

それが役に立てば幸い。

1
αNerd

コメントを追加したかったのですが、50ポイント未満なので、「回答」しかできません。 「VisualTreeHelper」メソッドを使用してXAML「TextBlock」オブジェクトを取得する場合、XAML「Button」オブジェクトも取得することに注意してください。 Textblock.Textパラメーターに書き込むことによって「TextBlock」オブジェクトを再初期化すると、Button.Contentパラメーターを使用してButtonテキストを変更できなくなります。ボタンは、Textblock.Text書き込みアクションから書き込まれたテキストを永久に表示します(取得時から-

foreach (TextBlock tb in FindVisualChildren<TextBlock>(window))
{
// do something with tb here
   tb.Text = ""; //this will overwrite Button.Content and render the 
                 //Button.Content{set} permanently disabled.
}

これを回避するには、XAML "TextBox"を使用して、XAMALボタンを模倣するメソッド(またはイベント)を追加します。 XAML "TextBox"は、 "TextBlock"の検索では収集されません。

1
Lifygen

C++/CLIの私のバージョン

template < class T, class U >
bool Isinst(U u) 
{
    return dynamic_cast< T >(u) != nullptr;
}

template <typename T>
    T FindVisualChildByType(Windows::UI::Xaml::DependencyObject^ element, Platform::String^ name)
    {
        if (Isinst<T>(element) && dynamic_cast<Windows::UI::Xaml::FrameworkElement^>(element)->Name == name)
        {
            return dynamic_cast<T>(element);
        }
        int childcount = Windows::UI::Xaml::Media::VisualTreeHelper::GetChildrenCount(element);
        for (int i = 0; i < childcount; ++i)
        {
            auto childElement = FindVisualChildByType<T>(Windows::UI::Xaml::Media::VisualTreeHelper::GetChild(element, i), name);
            if (childElement != nullptr)
            {
                return childElement;
            }
        }
        return nullptr;
    };
1
Whiso

accepted answerは、次のように、検出された要素を多少返しますunordered最初の子ブランチは可能な限り深く、途中で発見された要素を生成しながら、まだ解析されていないツリーブランチのステップをバックトラックおよび繰り返します。

降順の子孫要素が必要な場合、直接の子が最初に生成され、次に子などが生成され、次のアルゴリズムが機能します:

public static IEnumerable<T> GetVisualDescendants<T>(DependencyObject parent, bool applyTemplates = false)
    where T : DependencyObject
{
    if (parent == null || !(child is Visual || child is Visual3D))
        yield break;

    var descendants = new Queue<DependencyObject>();
    descendants.Enqueue(parent);

    while (descendants.Count > 0)
    {
        var currentDescendant = descendants.Dequeue();

        if (applyTemplates)
            (currentDescendant as FrameworkElement)?.ApplyTemplate();

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

            if (child is Visual || child is Visual3D)
                descendants.Enqueue(child);

            if (child is T foundObject)
                yield return foundObject;
        }
    }
}

結果の要素は、最も近いものから最も遠いものの順に並べられます。これは便利です。何らかのタイプと条件の最も近い子要素を探している場合:

var foundElement = GetDescendants<StackPanel>(someElement)
                       .FirstOrDefault(o => o.SomeProperty == SomeState);
0
lauxjpn

本当にいい答え。

VB.NETバージョン:

Public Shared Iterator Function FindVisualChildren(Of T As DependencyObject)(depObj As DependencyObject) As IEnumerable(Of T)
    If depObj IsNot Nothing Then
        For i As Integer = 0 To VisualTreeHelper.GetChildrenCount(depObj) - 1
            Dim child As DependencyObject = VisualTreeHelper.GetChild(depObj, i)
            If child IsNot Nothing AndAlso TypeOf child Is T Then
                Yield DirectCast(child, T)
            End If
            For Each childOfChild As T In FindVisualChildren(Of T)(child)
                Yield childOfChild
            Next
        Next
    End If
End Function

使用法(これはウィンドウ内のすべてのTextBoxを無効にします):

        For Each tb As TextBox In FindVisualChildren(Of TextBox)(Me)
          tb.IsEnabled = False
        Next
0