ฉันจะค้นหาตัวควบคุม WPF ตามชื่อหรือประเภทได้อย่างไร

ฉันต้องการค้นหาลำดับชั้นการควบคุม WPF สำหรับการควบคุมที่ตรงกับชื่อหรือประเภทที่กำหนด ฉันจะทำสิ่งนี้ได้อย่างไร

ฉันรวมรูปแบบเทมเพลตที่ใช้โดย John Myczek และอัลกอริทึมของ Tri Q ด้านบนเพื่อสร้างอัลกอริทึม findChild ที่สามารถใช้กับผู้ปกครองใด ๆ โปรดทราบว่าการค้นหาต้นไม้ซ้ำ ๆ ซ้ำ ๆ อาจเป็นกระบวนการที่ใช้เวลานาน ฉันตรวจสอบเฉพาะจุดนี้ในแอปพลิเคชัน WPF โปรดแสดงความคิดเห็นเกี่ยวกับข้อผิดพลาดที่คุณอาจพบและฉันจะแก้ไขรหัสของฉัน

WPF Snoopเป็นเครื่องมือที่มีประโยชน์ในการดูแผนผังต้นไม้ - ฉันขอแนะนำให้ใช้ขณะทดสอบหรือใช้อัลกอริทึมนี้เพื่อตรวจสอบงานของคุณ

มีข้อผิดพลาดเล็กน้อยในอัลกอริทึมของ Tri Q หลังจากพบเด็กแล้วถ้า childrenCount คือ> 1 และเราย้ำอีกครั้งเราสามารถเขียนทับเด็กที่พบได้อย่างถูกต้อง ดังนั้นฉันจึงเพิ่มif (foundChild != null) break;รหัสของฉันเพื่อจัดการกับเงื่อนไขนี้

/// <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สามารถเป็นหน้าต่างหลักใดก็ได้

คุณยังสามารถค้นหาองค์ประกอบตามชื่อโดยใช้FrameworkElement.FindName (สตริง)(สตริง)

ได้รับ:

<UserControl ...>
    <TextBlock x:Name="myTextBlock" />
</UserControl>

ในไฟล์ code-behind คุณสามารถเขียน:

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

แน่นอนเพราะมันถูกกำหนดโดยใช้ x: ชื่อคุณสามารถอ้างอิงฟิลด์ที่สร้างขึ้นได้ แต่บางทีคุณอาจต้องการค้นหาแบบไดนามิกมากกว่าแบบคงที่

วิธีนี้ใช้ได้สำหรับเทมเพลตซึ่งไอเท็มที่ชื่อปรากฏขึ้นหลายครั้ง (หนึ่งครั้งต่อการใช้เทมเพลต)

คุณสามารถใช้VisualTreeHelperเพื่อค้นหาการควบคุม ด้านล่างเป็นวิธีการที่ใช้ VisualTreeHelper เพื่อค้นหาการควบคุมหลักของประเภทที่ระบุ คุณสามารถใช้ VisualTreeHelper เพื่อค้นหาการควบคุมด้วยวิธีอื่นได้เช่นกัน

public static class UIHelper
{
   /// <summary>
   /// Finds a parent of a given item on the visual tree.
   /// </summary>
   /// <typeparam name="T">The type of the queried item.</typeparam>
   /// <param name="child">A direct or indirect child of the queried item.</param>
   /// <returns>The first parent item that matches the submitted type parameter. 
   /// If not matching item can be found, a null reference is being returned.</returns>
   public static T FindVisualParent<T>(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<T>(parentObject);
      }
   }
}

เรียกว่าเป็นแบบนี้:

Window owner = UIHelper.FindVisualParent<Window>(myControl);

ฉันอาจจะแค่ทำซ้ำคนอื่น แต่ฉันมีโค้ดที่ขยายคลาส 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 เป็นตัววนซ้ำนอกจากจะเป็นวิธีส่วนขยายสำหรับ DependencyObject
• FindChildren เดินต้นไม้ย่อยแบบลอจิคัลด้วยเช่นกัน ดูโพสต์ของ Josh Smith ที่เชื่อมโยงในโพสต์บล็อก

ที่มา: 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

หากคุณต้องการค้นหาการควบคุมทั้งหมดของประเภทเฉพาะคุณอาจสนใจตัวอย่างนี้

    public static IEnumerable<T> FindVisualChildren<T>(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<T>(child))
            {
                yield return other;
            }
        }
    }

สิ่งนี้จะยกเลิกองค์ประกอบบางอย่าง - คุณควรขยายออกเป็นดังนี้เพื่อรองรับการควบคุมที่กว้างขึ้น สำหรับการอภิปรายสั้น ๆ ดูที่นี่

 /// <summary>
 /// Helper methods for UI-related tasks.
 /// </summary>
 public static class UIHelper
 {
   /// <summary>
   /// Finds a parent of a given item on the visual tree.
   /// </summary>
   /// <typeparam name="T">The type of the queried item.</typeparam>
   /// <param name="child">A direct or indirect child of the
   /// queried item.</param>
   /// <returns>The first parent item that matches the submitted
   /// type parameter. If not matching item can be found, a null
   /// reference is being returned.</returns>
   public static T TryFindParent<T>(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<T>(parentObject);
     }
   }

   /// <summary>
   /// This method is an alternative to WPF's
   /// <see cref="VisualTreeHelper.GetParent"/> method, which also
   /// supports content elements. Do note, that for content element,
   /// this method falls back to the logical tree of the element!
   /// </summary>
   /// <param name="child">The item to be processed.</param>
   /// <returns>The submitted item's parent, if available. Otherwise
   /// null.</returns>
   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);
   }
}

ฉันแก้ไขโค้ดของ CrimsonX เนื่องจากมันไม่ทำงานกับประเภทซูเปอร์คลาส:

public static T FindChild<T>(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<T>(child, childName);

        if (obj != null)
            return obj;
    }

    return null;
}

ในขณะที่ฉันรักการสอบถามซ้ำโดยทั่วไปมันไม่ได้มีประสิทธิภาพเท่ากับการทำซ้ำเมื่อเขียนโปรแกรมใน C # ดังนั้นบางทีวิธีการแก้ปัญหาต่อไปนี้น่าจะดีกว่าที่ John Myczek แนะนำ สิ่งนี้จะค้นหาลำดับชั้นจากตัวควบคุมที่กำหนดเพื่อค้นหาตัวควบคุมบรรพบุรุษของชนิดเฉพาะ

public static T FindVisualAncestorOfType<T>(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;
}

เรียกเช่นนี้เพื่อค้นหาตัวWindowควบคุมที่มีชื่อว่าExampleTextBox:

Window window = ExampleTextBox.FindVisualAncestorOfType<Window>();

นี่คือรหัสของฉันเพื่อค้นหาการควบคุมตามประเภทในขณะที่ควบคุมว่าเราเข้าสู่ลำดับชั้นลึกแค่ไหน (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<object> list = new List<object>();
        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 ... ฉันมีปัญหากับรหัสของคุณที่ไม่ได้วนซ้ำผ่านการควบคุมของผู้ใช้ มันกระทบรูตกริดและส่งข้อผิดพลาด ฉันเชื่อว่านี่จะแก้ไขได้สำหรับฉัน:

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<object> list = new List<object>();
    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 (e.g., System.Windows.Controls.Grid)
            {
                if (maxDepth == 0 || depth < maxDepth)
                    list.AddRange(RecursiveFindControls(
                        collection, childType, depth + 1, maxDepth));
            }
        }
    }
    return list.ToArray();
}

ฉันมีฟังก์ชั่นการเรียงลำดับเช่นนี้ (ซึ่งโดยทั่วไปแล้วสมบูรณ์):

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

รับลูกทันที:

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

การหาเด็กทุกคนบนต้นไม้ที่มีความสำคัญสูง:

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

คุณสามารถเรียกสิ่งนี้ได้บนหน้าต่างเพื่อรับการควบคุมทั้งหมด

หลังจากที่คุณมีการรวบรวมคุณสามารถใช้ LINQ (เช่น OfType, ที่ไหน)

เนื่องจากคำถามทั่วไปเพียงพอที่จะดึงดูดผู้คนที่กำลังมองหาคำตอบของคดีเล็ก ๆ น้อย ๆ : ถ้าคุณแค่ต้องการลูกมากกว่าลูกหลานคุณสามารถใช้ 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();
    }
}

หรือแน่นอนชัดเจนสำหรับลูปวนซ้ำมากกว่าเด็ก

ตัวเลือกเหล่านี้ได้พูดคุยเกี่ยวกับการสำรวจทรี Visual ใน C # เป็นไปได้ที่จะสำรวจแผนผังต้นไม้ใน xaml เช่นกันโดยใช้ส่วนขยายมาร์กอัป RelativeSourceMSDN

ค้นหาตามประเภท

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

นี่คือวิธีแก้ปัญหาที่ใช้ภาคแสดงความยืดหยุ่น:

public static DependencyObject FindChild(DependencyObject parent, Func<DependencyObject, bool> 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;

รหัสนี้แก้ไขข้อผิดพลาดของ @CrimsonX answer:

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

 // 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
        {
          // child element found.
          foundChild = (T)child;
          break;
        }
      }

      return foundChild;
    }  

คุณเพียงแค่ต้องเรียกใช้เมธอดต่อเนื่องซ้ำหากประเภทตรงกัน แต่ชื่อไม่ได้ (เกิดขึ้นเมื่อคุณผ่านFrameworkElementเป็นT) ไม่งั้นมันจะกลับมาnullและมันก็ผิด

เพื่อค้นหาบรรพบุรุษของประเภทที่กำหนดจากรหัสคุณสามารถใช้:

[CanBeNull]
public static T FindAncestor<T>(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<T>(DependencyObject d) where T : DependencyObject
{
    while (true)
    {
        d = VisualTreeHelper.GetParent(d);

        if (d == null)
            return null;

        if (d is T t)
            return t;
    }
}

ลองสิ่งนี้

<TextBlock x:Name="txtblock" FontSize="24" >Hai Welcom to this page
</TextBlock>

รหัสเบื้องหลัง

var txtblock = sender as Textblock;
txtblock.Foreground = "Red"