如何按名称或类型查找 WPF 控件? [英] How can I find WPF controls by name or type?

问题描述

我需要在 WPF 控件层次结构中搜索与给定名称或类型匹配的控件.我该怎么做?

I need to search a WPF control hierarchy for controls that match a given name or type. How can I do this?

推荐答案

我结合了 John Myczek 使用的模板格式和上面的 Tri Q 算法，创建了一个可以在任何父级上使用的 findChild 算法.请记住，向下递归搜索树可能是一个漫长的过程.我只在 WPF 应用程序上抽查过这个，请评论您可能发现的任何错误，我会更正我的代码.

I combined the template format used by John Myczek and Tri Q's algorithm above to create a findChild Algorithm that can be used on any parent. Keep in mind that recursively searching a tree downwards could be a lengthy process. I've only spot-checked this on a WPF application, please comment on any errors you might find and I'll correct my code.

WPF Snoop 是查看可视化树的有用工具 - 我强烈建议使用它在测试或使用此算法来检查您的工作时.

WPF Snoop is a useful tool in looking at the visual tree - I'd strongly recommend using it while testing or using this algorithm to check your work.

Tri Q 的算法有一个小错误. 找到孩子后，如果childrenCount > 1，我们再次迭代，我们可以覆盖正确找到的孩子.因此我在我的代码中添加了一个 if (foundChild != null) break; 来处理这种情况.

There is a small error in Tri Q's Algorithm. After the child is found, if childrenCount is > 1 and we iterate again we can overwrite the properly found child. Therefore I added a if (foundChild != null) break; into my code to deal with this condition.

/// <summary>
/// Finds a Child of a given item in the visual tree. 
/// </summary>
/// <param name="parent">A direct parent of the queried item.</param>
/// <typeparam name="T">The type of the queried item.</typeparam>
/// <param name="childName">x:Name or Name of child. </param>
/// <returns>The first parent item that matches the submitted type parameter. 
/// If not matching item can be found, 
/// a null parent is being returned.</returns>
public static T FindChild<T>(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<T>(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<TextBox>(Application.Current.MainWindow, "myTextBoxName");

注意 Application.Current.MainWindow 可以是任何父窗口.

Note Application.Current.MainWindow can be any parent window.

这篇关于如何按名称或类型查找 WPF 控件?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！