WPF中查找控件的扩展类

小渣渣

在wpf中查找控件要用到VisualTreeHelper类，但这个类并没有按照名字查找控件的方法，于是搜索网络，整理出下面这个类，感觉用起来很是方便。

贴出来，供大家参考。

1. /// <summary>
   
2. /// WPF/Silverlight 查找控件扩展方法
   
3. /// </summary>
   
4. public static class VisualHelperTreeExtension
   
5. {
   
6.     /// <summary>
   
7.     /// 根据控件名称，查找父控件
   
8.     /// elementName为空时，查找指定类型的父控件
   
9.     /// </summary>
   
10.     public static T GetParentByName<T>(this DependencyObject obj, string elementName)
    
11.     where T : FrameworkElement
    
12.     {
    
13.         DependencyObject parent = VisualTreeHelper.GetParent(obj);
    
14.         while (parent != null)
    
15.         {
    
16.             if ((parent is T) && (((T)parent).Name == elementName || string.IsNullOrEmpty(elementName)))
    
17.             {
    
18.                 return (T)parent;
    
19.             }
    
20.             parent = VisualTreeHelper.GetParent(parent);
    
21.         }
    
22. 
    
23.         return null;
    
24.     }
    
25. 
    
26.     /// <summary>
    
27.     /// 根据控件名称，查找子控件
    
28.     /// elementName为空时，查找指定类型的子控件
    
29.     /// </summary>
    
30.     public static T GetChildByName<T>(this DependencyObject obj, string elementName)
    
31.     where T : FrameworkElement
    
32.     {
    
33.         DependencyObject child = null;
    
34.         for (int i = 0; i < VisualTreeHelper.GetChildrenCount(obj); i++)
    
35.         {
    
36.             child = VisualTreeHelper.GetChild(obj, i);
    
37.             if (child is T && (((T)child).Name == elementName) || (string.IsNullOrEmpty(elementName)))
    
38.             {
    
39.                 return (T)child;
    
40.             }
    
41.             else
    
42.             {
    
43.                 T grandChild = GetChildByName<T>(child, elementName);
    
44.                 if (grandChild != null)
    
45.                 {
    
46.                     return grandChild;
    
47.                 }
    
48.             }
    
49.         }
    
50.         return null;
    
51.     }
    
52. 
    
53.     /// <summary>
    
54.     /// 根据控件名称，查找子控件集合
    
55.     /// elementName为空时，查找指定类型的所有子控件
    
56.     /// </summary>
    
57.     public static List<T> GetChildsByName<T>(this DependencyObject obj, string elementName)
    
58.     where T : FrameworkElement
    
59.     {
    
60.         DependencyObject child = null;
    
61.         List<T> childList = new List<T>();
    
62.         for (int i = 0; i < VisualTreeHelper.GetChildrenCount(obj); i++)
    
63.         {
    
64.             child = VisualTreeHelper.GetChild(obj, i);
    
65.             if (child is T && (((T)child).Name == elementName) || (string.IsNullOrEmpty(elementName)))
    
66.             {
    
67.                 childList.Add((T)child);
    
68.             }
    
69.             else
    
70.             {
    
71.                 List<T> grandChildList = GetChildsByName<T>(child, elementName);
    
72.                 if (grandChildList != null)
    
73.                 {
    
74.                     childList.AddRange(grandChildList);
    
75.                 }
    
76.             }
    
77.         }
    
78.         return childList;
    
79.     }
    
80. }
    

复制代码

使用的时候非常简单，比如查找datagrid里模板列的一个叫“myTextBox”的文本框，可以这样写：

1. var child = dataGrid.GetChildByName<TextBox>("myTextBox");
   
2. if (child != null)
   
3. {
   
4.     child.Text = "abc";
   
5. }

复制代码

注意：初期化页面的时候，如果查找控件的代码放在Loaded事件中，会找不到控件；应该放在LayoutUpdated事件中，这时候xaml已经加载完毕，所有的子控件才能取到。

但是LayoutUpdated事件只要页面有更新，它都会触发，如果要达到Loaded事件的效果，我们可以设置一个flag在控制代码只在初期化时执行一次，现在也没有想到更好的办法来实现，大概如下：

1. bool firstLoad = true;
   
2. private void UserControl_LayoutUpdated(object sender, EventArgs e)
   
3. {
   
4.     if (firstLoad)
   
5.     {
   
6.         //第一次加载要执行的代码
   
7.         //...
   
8.         firstLoad = false;
   
9.     }
   
10. }

复制代码