Suchen Sie alle Steuerelemente im WPF-Fenster nach Typ

218

Ich suche nach einer Möglichkeit, alle Steuerelemente in Window nach Typ zu finden.

Zum Beispiel: Alle TextBoxesfinden, alle Steuerelemente finden , die eine bestimmte Schnittstelle implementieren usw.

Andrija
quelle
Während wir uns mit dem Thema befassen
Andrija
Ich schrieb auch einen Blog-Beitrag zum Thema: Ändern einer ControlTemplate zur Laufzeit
Adolfo Perez

Antworten:

430

Dies sollte den Trick tun

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;
            }
        }
    }
}

dann zählst du wie folgt über die Steuerelemente auf

foreach (TextBlock tb in FindVisualChildren<TextBlock>(window))
{
    // do something with tb here
}
Bryce Kahle
quelle
68
Hinweis: Wenn Sie versuchen, dies zum Laufen zu bringen und feststellen, dass Ihr Fenster (zum Beispiel) 0 visuelle untergeordnete Elemente hat, führen Sie diese Methode im Loaded-Ereignishandler aus. Wenn Sie es im Konstruktor ausführen (auch nach InitializeComponent ()), werden die visuellen untergeordneten Elemente noch nicht geladen und es funktioniert nicht.
Ryan Lundy
24
Wenn Sie von VisualTreeHelper zu LogicalTreeHelpers wechseln, werden auch unsichtbare Elemente eingeschlossen.
Mathias Lykkegaard Lorenzen
11
Ist die Zeile "child! = Null && child is T" nicht redundant? Sollte es nicht nur "Kind ist T" lesen
Mittag und
1
Ich würde es in eine Erweiterungsmethode verwandeln, indem ich nur ein thisVorher einfügte DependencyObject=>this DependencyObject depObj
Johannes Wanzek
1
@JohannesWanzek Vergessen Sie nicht, dass Sie auch das Bit ändern müssen, in dem Sie es für das Kind nennen: foreach (ChildofChild.FindVisualChildren <T> ()) {bla bla bla}
Will
66

Dies ist der einfachste Weg:

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

Dabei ist die Steuerung das Stammelement des Fensters.

Joel
quelle
1
Was meinst du mit "Wurzelelement"? Was soll ich schreiben, um mich mit meinem Hauptfensterformular zu verbinden?
Deadfish
Ich verstehe, in der XAML-Ansicht musste ich den Namen für das Raster festlegen <Grid Name="Anata_wa_yoru_o_shihai_suru_ai">here buttons</Grid>und dann konnte ichAnata_wa_yoru_o_shihai_suru_ai.Children.OfType<myType>();
Deadfish
68
Dies beantwortet nicht die gestellte Frage. Untergeordnete Steuerelemente werden nur eine Ebene tiefer zurückgegeben.
Jim
21

Ich habe die Antwort von @Bryce Kahle angepasst, um dem Vorschlag und der Verwendung von @Mathias Lykkegaard Lorenzen zu folgen LogicalTreeHelper.

Scheint in Ordnung zu funktionieren. ;)

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;
                }
            }
        }
    }
}

(Tab-Steuerelemente oder Raster in GroupBoxen werden weiterhin nicht überprüft, wie von @Benjamin Berry und @David R erwähnt.) (Befolgen Sie auch den Vorschlag von @ lunand und entfernen Sie das redundante untergeordnete Element! = Null)

Simon F.
quelle
Ich habe eine Weile gesucht, wie ich alle meine Textfelder löschen kann. Ich habe mehrere Registerkarten und dies ist der einzige Code, der funktioniert hat :) Danke
JohnChris
13

Verwenden Sie die Hilfsklassen VisualTreeHelperoder LogicalTreeHelperje nachdem, für welchen Baum Sie sich interessieren. Beide bieten Methoden zum Abrufen der untergeordneten Elemente eines Elements (obwohl sich die Syntax geringfügig unterscheidet). Ich verwende diese Klassen häufig, um das erste Vorkommen eines bestimmten Typs zu finden, aber Sie können es leicht ändern, um alle Objekte dieses Typs zu finden:

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;
}
Oskar
quelle
+1 für Erklärung und Post, aber Bryce Kahle hat eine Funktion gepostet, die voll funktioniert. Danke
Andrija
Dies behebt das Problem der Frage nicht und auch die Antwort mit dem generischen Typ ist viel klarer. Durch die Kombination mit VisualTreeHelper.GetChildrenCount (obj) wird das Problem behoben. Es ist jedoch nützlich, als Option in Betracht gezogen zu werden.
Vasil Popov
9

Ich habe festgestellt, dass die Zeile, VisualTreeHelper.GetChildrenCount(depObj);die in mehreren Beispielen oben verwendet wurde, keine Zählung ungleich Null für GroupBoxes zurückgibt, insbesondere wenn das Element a GroupBoxenthält Gridund das GridElement untergeordnet ist. Ich glaube, das kann daran liegen, dass das GroupBoxnicht mehr als ein Kind enthalten darf und dies in seinem ContentEigentum gespeichert ist . Es gibt keine GroupBox.ChildrenArt von Eigentum. Ich bin mir sicher, dass ich dies nicht sehr effizient gemacht habe, aber ich habe das erste "FindVisualChildren" -Beispiel in dieser Kette wie folgt geändert:

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; 
            } 
        }
    }
} 
David R.
quelle
4

Um eine Liste aller Kinder eines bestimmten Typs zu erhalten, können Sie Folgendes verwenden:

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;
}
Michael
quelle
4

Kleine Änderung an der Rekursion zu, damit Sie beispielsweise das untergeordnete Registersteuerelement eines Registersteuerelements finden können.

    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;
    }
Benjamin Berry
quelle
3

Hier ist noch eine weitere, kompakte Version mit der generischen Syntax:

    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;
        }
    }
user1656671
quelle
2

Und so funktioniert es nach oben

    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);
                }
            }
        }
    }

quelle
2

Beachten Sie, dass die Verwendung von VisualTreeHelper nur für Steuerelemente funktioniert, die von Visual oder Visual3D abgeleitet sind. Wenn Sie auch andere Elemente (z. B. TextBlock, FlowDocument usw.) überprüfen müssen, löst die Verwendung von VisualTreeHelper eine Ausnahme aus.

Hier ist eine Alternative, die bei Bedarf auf den logischen Baum zurückgreift:

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

Philipp
quelle
1

Ich wollte einen Kommentar hinzufügen, habe aber weniger als 50 Punkte, sodass ich nur "antworten" kann. Beachten Sie, dass bei Verwendung der "VisualTreeHelper" -Methode zum Abrufen von XAML "TextBlock" -Objekten auch XAML "Button" -Objekte erfasst werden. Wenn Sie das Objekt "TextBlock" durch Schreiben in den Parameter Textblock.Text neu initialisieren, können Sie den Button-Text nicht mehr mit dem Parameter Button.Content ändern. Die Schaltfläche zeigt permanent den Text an, der vom Textblock geschrieben wurde. Textschreibaktion (ab dem Zeitpunkt, an dem er abgerufen wurde -

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.
}

Um dies zu umgehen, können Sie versuchen, eine XAML "TextBox" zu verwenden und Methoden (oder Ereignisse) hinzuzufügen, um eine XAMAL-Schaltfläche nachzuahmen. XAML "TextBox" wird nicht durch eine Suche nach "TextBlock" erfasst.

Lifygen
quelle
Das ist der Unterschied zwischen dem visuellen und dem logischen Baum. Der visuelle Baum enthält alle Steuerelemente (einschließlich derjenigen, aus denen ein Steuerelement besteht und die in der Steuerelementvorlage definiert sind), während der logische Baum nur die tatsächlichen Steuerelemente enthält (ohne die in Vorlagen definierten Steuerelemente). Es gibt eine schöne Visualisierung dieses Konzepts hier: link
lauxjpn
1

Meine Version für 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;
    };
Whiso
quelle
1

Aus irgendeinem Grund hat mir keine der hier veröffentlichten Antworten geholfen, alle Steuerelemente eines bestimmten Typs in einem bestimmten Steuerelement in meinem MainWindow abzurufen. Ich musste alle Menüpunkte in einem Menü finden, um sie zu wiederholen. Sie waren nicht alle direkte Nachkommen des Menüs, also habe ich es geschafft, nur die erste Lilne von ihnen mit einem der obigen Codes zu sammeln. Diese Erweiterungsmethode ist meine Lösung für das Problem für alle, die hier unten weiterlesen.

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);
                }
            }
        }
    }

Ich hoffe es hilft.

αNerd
quelle
1

Die akzeptierte Antwort gibt die erkannten Elemente mehr oder weniger ungeordnet zurück , indem sie dem ersten untergeordneten Zweig so tief wie möglich folgt und dabei die erkannten Elemente liefert, bevor die Schritte für noch nicht analysierte Äste zurückverfolgt und wiederholt werden.

Wenn Sie die absteigenden Elemente in absteigender Reihenfolge benötigen , in der zuerst die direkten untergeordneten Elemente , dann ihre untergeordneten Elemente usw. ausgegeben werden, funktioniert der folgende Algorithmus:

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;
        }
    }
}

Die resultierenden Elemente werden vom nächstgelegenen zum entferntesten geordnet. Dies ist nützlich, z. B. wenn Sie nach dem nächsten untergeordneten Element eines Typs und einer Bedingung suchen:

var foundElement = GetDescendants<StackPanel>(someElement)
                       .FirstOrDefault(o => o.SomeProperty == SomeState);
lauxjpn
quelle
1
Fehlt etwas? childist nicht definiert.
Codebender
1

@ Bryce, wirklich schöne Antwort.

VB.NET-Version:

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

Verwendung (dies deaktiviert alle Textfelder in einem Fenster):

        For Each tb As TextBox In FindVisualChildren(Of TextBox)(Me)
          tb.IsEnabled = False
        Next
Andrea Antonangeli
quelle
-1

Ich fand es einfacher ohne Visual Tree Helpers:

foreach (UIElement element in MainWindow.Children) {
    if (element is TextBox) { 
        if ((element as TextBox).Text != "")
        {
            //Do something
        }
    }
};
Rafael Ventura
quelle
3
Dies geht nur eine Ebene tief. In XAML haben Sie tief verschachtelte Steuerelemente.
SQL Police