Как я могу найти элементы управления WPF по имени или типу?

Мне нужно найти иерархию управления WPF для элементов управления, которые соответствуют заданному имени или типу. Как я могу это сделать?

18 Solutions collect form web for “Как я могу найти элементы управления WPF по имени или типу?”

Я объединил формат шаблона, используемый Джоном Мичеком и алгоритмом Tri Q выше, чтобы создать алгоритм findChild, который можно использовать для любого родителя. Имейте в виду, что рекурсивный поиск дерева вниз может быть длительным процессом. Я только проверял это в приложении WPF, прокомментируйте любые ошибки, которые могут найти, и я исправлю свой код.

WPF Snoop – полезный инструмент для просмотра визуального дерева – я настоятельно рекомендую использовать его во время тестирования или использования этого алгоритма для проверки вашей работы.

В алгоритме Tri Q имеется небольшая ошибка. После того, как ребенок найден, если childrenCount> 1, и мы снова повторяем, мы можем перезаписать правильно найденный ребенок. Поэтому я добавил if (foundChild != null) break; в мой код, чтобы справиться с этим условием.

 ///  /// Finds a Child of a given item in the visual tree. ///  /// A direct parent of the queried item. /// The type of the queried item. /// x:Name or Name of child.  /// The first parent item that matches the submitted type parameter. /// If not matching item can be found, /// a null parent is being returned. public static T FindChild(DependencyObject parent, string childName) where T : DependencyObject { // Confirm parent and childName are valid. if (parent == null) return null; T foundChild = null; int childrenCount = VisualTreeHelper.GetChildrenCount(parent); for (int i = 0; i < childrenCount; i++) { var child = VisualTreeHelper.GetChild(parent, i); // If the child is not of the request child type child T childType = child as T; if (childType == null) { // recursively drill down the tree foundChild = FindChild(child, childName); // If the child is found, break so we do not overwrite the found child. if (foundChild != null) break; } else if (!string.IsNullOrEmpty(childName)) { var frameworkElement = child as FrameworkElement; // If the child's name is set for search if (frameworkElement != null && frameworkElement.Name == childName) { // if the child's name is of the request name foundChild = (T)child; break; } } else { // child element found. foundChild = (T)child; break; } } return foundChild; } 

Назовите это так:

 TextBox foundTextBox = UIHelper.FindChild(Application.Current.MainWindow, "myTextBoxName"); 

Примечание. Application.Current.MainWindow может быть любым родительским окном.

Вы также можете найти элемент по имени, используя FrameworkElement.FindName (string) .

Данный:

    

В файле кода вы можете написать:

 var myTextBlock = (TextBlock)this.FindName("myTextBlock"); 

Конечно, поскольку он определяется с помощью x: Name, вы можете просто ссылаться на сгенерированное поле, но, возможно, вам нужно искать его динамически, а не статически.

Этот подход также доступен для шаблонов, в которых именованный элемент появляется несколько раз (один раз за использование шаблона).

Вы можете использовать VisualTreeHelper для поиска элементов управления. Ниже приведен метод, который использует VisualTreeHelper для поиска родительского элемента управления указанного типа. Вы можете использовать VisualTreeHelper для поиска элементов управления другими способами.

 public static class UIHelper { ///  /// Finds a parent of a given item on the visual tree. ///  /// The type of the queried item. /// A direct or indirect child of the queried item. /// The first parent item that matches the submitted type parameter. /// If not matching item can be found, a null reference is being returned. public static T FindVisualParent(DependencyObject child) where T : DependencyObject { // get parent item DependencyObject parentObject = VisualTreeHelper.GetParent(child); // we've reached the end of the tree if (parentObject == null) return null; // check if the parent matches the type we're looking for T parent = parentObject as T; if (parent != null) { return parent; } else { // use recursion to proceed with next level return FindVisualParent(parentObject); } } } 

Назовите это так:

 Window owner = UIHelper.FindVisualParent(myControl); 

Я могу просто повторять всех остальных, но у меня есть довольно кусочек кода, который расширяет class DependencyObject с помощью метода FindChild (), который предоставит вам имя по типу и имени. Просто включите и используйте.

 public static class UIChildFinder { public static DependencyObject FindChild(this DependencyObject reference, string childName, Type childType) { DependencyObject foundChild = null; if (reference != null) { int childrenCount = VisualTreeHelper.GetChildrenCount(reference); for (int i = 0; i < childrenCount; i++) { var child = VisualTreeHelper.GetChild(reference, i); // If the child is not of the request child type child if (child.GetType() != childType) { // recursively drill down the tree foundChild = FindChild(child, childName, childType); } else if (!string.IsNullOrEmpty(childName)) { var frameworkElement = child as FrameworkElement; // If the child's name is set for search if (frameworkElement != null && frameworkElement.Name == childName) { // if the child's name is of the request name foundChild = child; break; } } else { // child element found. foundChild = child; break; } } } return foundChild; } } 

Надеюсь, вы найдете ее полезной.

Мои расширения кода.

  • Добавлены перегрузки, чтобы найти одного ребенка по типу, по типу и критериям (предикат), найти всех детей типа, которые соответствуют критериям
  • метод FindChildren является iteratorом в дополнение к методу расширения для DependencyObject
  • FindChildren также выполняет логические поддеревья. См. Сообщение Джоша Смита, связанное в блоге.

Источник: https://code.google.com/p/gishu-util/source/browse/#git%2FWPF%2FUtilities

Пояснительное сообщение в блоге: http://madcoderspeak.blogspot.com/2010/04/wpf-find-child-control-of-specific-type.html

Если вы хотите найти ВСЕ элементы управления определенного типа, вам может быть интересен этот fragment

  public static IEnumerable FindVisualChildren(DependencyObject parent) where T : DependencyObject { int childrenCount = VisualTreeHelper.GetChildrenCount(parent); for (int i = 0; i < childrenCount; i++) { var child = VisualTreeHelper.GetChild(parent, i); var childType = child as T; if (childType != null) { yield return (T)child; } foreach (var other in FindVisualChildren(child)) { yield return other; } } } 

Я редактировал код CrimsonX, поскольку он не работал с типами суперclassа:

 public static T FindChild(DependencyObject depObj, string childName) where T : DependencyObject { // Confirm obj is valid. if (depObj == null) return null; // success case if (depObj is T && ((FrameworkElement)depObj).Name == childName) return depObj as T; for (int i = 0; i < VisualTreeHelper.GetChildrenCount(depObj); i++) { DependencyObject child = VisualTreeHelper.GetChild(depObj, i); //DFS T obj = FindChild(child, childName); if (obj != null) return obj; } return null; } 

Это отклонит некоторые элементы – вы должны расширить его таким образом, чтобы поддерживать более широкий набор элементов управления. Для краткого обсуждения, посмотрите здесь

  ///  /// Helper methods for UI-related tasks. ///  public static class UIHelper { ///  /// Finds a parent of a given item on the visual tree. ///  /// The type of the queried item. /// A direct or indirect child of the /// queried item. /// The first parent item that matches the submitted /// type parameter. If not matching item can be found, a null /// reference is being returned. public static T TryFindParent(DependencyObject child) where T : DependencyObject { //get parent item DependencyObject parentObject = GetParentObject(child); //we've reached the end of the tree if (parentObject == null) return null; //check if the parent matches the type we're looking for T parent = parentObject as T; if (parent != null) { return parent; } else { //use recursion to proceed with next level return TryFindParent(parentObject); } } ///  /// This method is an alternative to WPF's ///  method, which also /// supports content elements. Do note, that for content element, /// this method falls back to the logical tree of the element! ///  /// The item to be processed. /// The submitted item's parent, if available. Otherwise /// null. public static DependencyObject GetParentObject(DependencyObject child) { if (child == null) return null; ContentElement contentElement = child as ContentElement; if (contentElement != null) { DependencyObject parent = ContentOperations.GetParent(contentElement); if (parent != null) return parent; FrameworkContentElement fce = contentElement as FrameworkContentElement; return fce != null ? fce.Parent : null; } //if it's not a ContentElement, rely on VisualTreeHelper return VisualTreeHelper.GetParent(child); } } 

Хотя я люблю рекурсию в целом, она не так эффективна, как итерация при программировании на C #, так что, возможно, следующее решение более аккуратное, чем предложенное Джоном Мичеком выше?

 public static T FindVisualAncestorOfType(this DependencyObject Elt) where T : DependencyObject { for (DependencyObject parent = VisualTreeHelper.GetParent(Elt); parent != null; parent = VisualTreeHelper.GetParent(parent)) { T result = parent as T; if (result != null) return result; } return null; } 

Вот мой код, чтобы находить элементы управления по типу, контролируя, насколько глубоко мы идем в иерархию (maxDepth == 0 означает бесконечно глубокое).

 public static class FrameworkElementExtension { public static object[] FindControls( this FrameworkElement f, Type childType, int maxDepth) { return RecursiveFindControls(f, childType, 1, maxDepth); } private static object[] RecursiveFindControls( object o, Type childType, int depth, int maxDepth = 0) { List list = new List(); var attrs = o.GetType() .GetCustomAttributes(typeof(ContentPropertyAttribute), true); if (attrs != null && attrs.Length > 0) { string childrenProperty = (attrs[0] as ContentPropertyAttribute).Name; foreach (var c in (IEnumerable)o.GetType() .GetProperty(childrenProperty).GetValue(o, null)) { if (c.GetType().FullName == childType.FullName) list.Add(c); if (maxDepth == 0 || depth < maxDepth) list.AddRange(RecursiveFindControls( c, childType, depth + 1, maxDepth)); } } return list.ToArray(); } } 

exciton80 … У меня возникла проблема с тем, что ваш код не рекурсировал через usercontrols. Он попал в корень сетки и выбросил ошибку. Я считаю, что это исправляет это для меня:

 public static object[] FindControls(this FrameworkElement f, Type childType, int maxDepth) { return RecursiveFindControls(f, childType, 1, maxDepth); } private static object[] RecursiveFindControls(object o, Type childType, int depth, int maxDepth = 0) { List list = new List(); var attrs = o.GetType().GetCustomAttributes(typeof(ContentPropertyAttribute), true); if (attrs != null && attrs.Length > 0) { string childrenProperty = (attrs[0] as ContentPropertyAttribute).Name; if (String.Equals(childrenProperty, "Content") || String.Equals(childrenProperty, "Children")) { var collection = o.GetType().GetProperty(childrenProperty).GetValue(o, null); if (collection is System.Windows.Controls.UIElementCollection) // snelson 6/6/11 { foreach (var c in (IEnumerable)collection) { if (c.GetType().FullName == childType.FullName) list.Add(c); if (maxDepth == 0 || depth < maxDepth) list.AddRange(RecursiveFindControls( c, childType, depth + 1, maxDepth)); } } else if (collection != null && collection.GetType().BaseType.Name == "Panel") // snelson 6/6/11; added because was skipping control (eg, System.Windows.Controls.Grid) { if (maxDepth == 0 || depth < maxDepth) list.AddRange(RecursiveFindControls( collection, childType, depth + 1, maxDepth)); } } } return list.ToArray(); } 

У меня есть такая функция последовательности (что является полностью общей):

  public static IEnumerable SelectAllRecursively(this IEnumerable items, Func> func) { return (items ?? Enumerable.Empty()).SelectMany(o => new[] { o }.Concat(SelectAllRecursively(func(o), func))); } 

Получение непосредственных детей:

  public static IEnumerable FindChildren(this DependencyObject obj) { return Enumerable.Range(0, VisualTreeHelper.GetChildrenCount(obj)) .Select(i => VisualTreeHelper.GetChild(obj, i)); } 

Поиск всех детей по иерархическому дереву:

  public static IEnumerable FindAllChildren(this DependencyObject obj) { return obj.FindChildren().SelectAllRecursively(o => o.FindChildren()); } 

Вы можете вызвать это в окне, чтобы получить все элементы управления.

После того, как у вас есть коллекция, вы можете использовать LINQ (т.е. OfType, Where).

Поскольку вопрос достаточно общий, что он может привлечь людей, которые ищут ответы на очень тривиальные случаи: если вы просто хотите ребенка, а не потомка, вы можете использовать Linq:

 private void ItemsControlItem_Loaded(object sender, RoutedEventArgs e) { if (SomeCondition()) { var children = (sender as Panel).Children; var child = (from Control child in children where child.Name == "NameTextBox" select child).First(); child.Focus(); } } 

или, конечно, очевидное для цикла, повторяющего детей.

Вот решение, которое использует гибкий предикат:

 public static DependencyObject FindChild(DependencyObject parent, Func predicate) { if (parent == null) return null; int childrenCount = VisualTreeHelper.GetChildrenCount(parent); for (int i = 0; i < childrenCount; i++) { var child = VisualTreeHelper.GetChild(parent, i); if (predicate(child)) { return child; } else { var foundChild = FindChild(child, predicate); if (foundChild != null) return foundChild; } } return null; } 

Вы можете, например, вызвать его так:

 var child = FindChild(parent, child => { var textBlock = child as TextBlock; if (textBlock != null && textBlock.Name == "MyTextBlock") return true; else return false; }) as TextBlock; 

Эти параметры уже говорят об обходе визуального дерева в C #. Его можно также пересечь визуальное дерево в xaml, используя расширение разметки RelativeSource. MSDN

Поиск по типу

 Binding="{Binding RelativeSource={RelativeSource Mode=FindAncestor, AncestorType={x:Type }}}" 

Чтобы найти предок данного типа из кода, вы можете использовать:

 [CanBeNull] public static T FindAncestor(DependencyObject d) where T : DependencyObject { while (true) { d = VisualTreeHelper.GetParent(d); if (d == null) return null; var t = d as T; if (t != null) return t; } } 

Эта реализация использует итерацию вместо рекурсии, которая может быть немного быстрее.

Если вы используете C # 7, это можно сделать немного короче:

 [CanBeNull] public static T FindAncestor(DependencyObject d) where T : DependencyObject { while (true) { d = VisualTreeHelper.GetParent(d); if (d == null) return null; if (d is T t) return t; } } 

Этот код просто исправляет ошибку @CrimsonX answer:

  public static T FindChild(DependencyObject parent, string childName) where T : DependencyObject { // Confirm parent and childName are valid. if (parent == null) return null; T foundChild = null; int childrenCount = VisualTreeHelper.GetChildrenCount(parent); for (int i = 0; i < childrenCount; i++) { var child = VisualTreeHelper.GetChild(parent, i); // If the child is not of the request child type child T childType = child as T; if (childType == null) { // recursively drill down the tree foundChild = FindChild(child, childName); // If the child is found, break so we do not overwrite the found child. if (foundChild != null) break; } else if (!string.IsNullOrEmpty(childName)) { var frameworkElement = child as FrameworkElement; // If the child's name is set for search if (frameworkElement != null && frameworkElement.Name == childName) { // if the child's name is of the request name foundChild = (T)child; break; } // recursively drill down the tree foundChild = FindChild(child, childName); // If the child is found, break so we do not overwrite the found child. if (foundChild != null) break; else { // child element found. foundChild = (T)child; break; } } return foundChild; } 

Вам просто нужно продолжить вызов метода рекурсивно, если типы совпадают, но имена не выполняются (это происходит, когда вы передаете FrameworkElement как T ). иначе он будет возвращать null и это неправильно.

Попробуй это

 Hai Welcom to this page  

Код за

 var txtblock = sender as Textblock; txtblock.Foreground = "Red" 
Interesting Posts
Давайте будем гением компьютера.