이름 또는 유형별로 WPF 컨트롤을 찾으려면 어떻게해야합니까?


264

주어진 이름이나 유형과 일치하는 컨트롤에 대한 WPF 컨트롤 계층을 검색해야합니다. 어떻게해야합니까?

답변:


311

위의 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모든 부모 윈도우가 될 수 있습니다.


@ 크림슨 (XrimsonX) : 어쩌면이 잘못하고있을 것입니다 ... ContentControl (Expander) 내부의 컨트롤 (ListBox)에 접근 해야하는 비슷한 요구가있었습니다. 위 코드는 그대로 작동하지 않았습니다. 리프 노드 (GetChildrenCount => 0)가 ContentControl인지 확인하려면 위 코드를 업데이트해야했습니다. 그렇다면 콘텐츠가 이름 + 유형 기준과 일치하는지 확인하십시오.
Gishu

@ 기슈-나는 이것이 목적을 위해 작동해야한다고 생각합니다. 통화를 어떻게 사용하고 있는지 보여주기 위해 코드를 복사하여 붙여 넣을 수 있습니까? FindChild <ListBox> (Expander myExpanderName, "myListBoxName")이어야합니다.
CrimsonX

3
@ 크림슨 X 나는 또 다른 코너 사건을 발견했다고 생각합니다. RibbonApplicationMenuItem에서 PART_SubmenuPlaceholder를 찾으려고했지만 위의 코드가 작동하지 않았습니다. 이를 해결하려면 다음을 추가해야했습니다. if (name == ElementName) else {foundChild = FindChild (child, name) if (foundChild! = null) break; }
kevindaub

6
답변에 버그가 있거나 더 조심하십시오. 검색된 유형의 하위 항목에 도달하면 중지됩니다. 다른 답변을 고려하거나 우선 순위를 정해야한다고 생각합니다.
Eric Ouellet

2
이 코드는 훌륭하지만 특정 유형의 요소를 찾지 않으면 작동하지 않습니다. 예를 들어 FrameworkElementT로 전달하면 첫 번째 루프가 끝나 자마자 null을 반환합니다. 몇 가지 수정이 필요합니다.
Amir Oveisi

131

FrameworkElement.FindName (string)을 사용하여 이름으로 요소를 찾을 수도 있습니다 .

주어진:

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

코드 숨김 파일에서 다음을 작성할 수 있습니다.

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

물론 x : Name을 사용하여 정의되었으므로 생성 된 필드를 참조 할 수 있지만 정적으로가 아니라 동적으로 조회하려고 할 수 있습니다.

이 방법은 명명 된 항목이 여러 번 나타나는 (템플릿 사용 당 한 번) 템플릿에도 사용할 수 있습니다.


6
이것이 작동하기 위해 반드시 name 속성에 "x :"를 추가 할 필요는 없습니다.
brian buck

3
항상 작동하지 않는 것 같습니다. 속성 창의 내용으로 중첩 된 그리드에서 프로그래밍 방식으로 결합 된 UserControls가 있습니다. 그러나 CrimsonX의 대답은 잘 작동합니다.
Matt

4
ItemControls, ListBoxes 등의 요소에서는 작동하지 않습니다.
Sorensen

67

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

myControl은 어떻게 얻거나 무엇입니까?
Demodave

21

나는 다른 모든 사람들을 반복 할 수도 있지만 유형과 이름으로 아이를 얻을 수있는 FindChild () 메서드를 사용하여 DependencyObject 클래스를 확장하는 예쁜 코드가 있습니다. 포함하고 사용하십시오.

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

도움이 되길 바랍니다.


2
위 내 게시물 당, 코드의 작은 구현 오류가 있습니다 : stackoverflow.com/questions/636383/wpf-ways-to-find-controls/...
CrimsonX

18

코드에 대한 내 확장.

  • 유형, 유형 및 기준 (조건 자)별로 하나의 하위 항목을 찾고, 기준을 충족하는 유형의 모든 하위 항목을 찾기위한 과부하를 추가했습니다.
  • FindChildren 메서드는 DependencyObject의 확장 메서드 일뿐 아니라 반복자입니다.
  • FindChildren도 논리 하위 트리를 걷습니다. 블로그 게시물에 링크 된 Josh Smith의 게시물을 참조하십시오.

출처 : https://code.google.com/p/gishu-util/source/browse/#git%2FWPF%2F 유틸리티

설명 블로그 게시물 : http://madcoderspeak.blogspot.com/2010/04/wpf-find-child-control-of-specific-type.html


-1 정확히 구현하려고하는 것 (조건 자, 반복자 및 확장 방법)이지만 소스 링크에는 404가 있습니다. 코드가 여기에 포함되거나 소스 링크가 수정되면 +1로 변경됩니다!
cod3monk3y

@ cod3monk3y-Git 마이그레이션이 링크를 죽인 것 같습니다 :) 여기 있습니다. code.google.com/p/gishu-util/source/browse/…
Gishu

18

특정 유형의 모든 컨트롤을 찾으려면이 스 니펫에도 관심이있을 수 있습니다.

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

3
좋은 것이지만 컨트롤이로드되어 있는지 확인하십시오. 그렇지 않으면 GetChildrenCount는 0을 반환합니다.
Klaus

@UrbanEsc, 왜 child두 번째로 캐스팅 합니까? childType타입 이 있다면 다음 과 같이 T쓸 수 있습니다 if: yield return childType... no?
Massimiliano Kraus

@MassimilianoKraus 이봐, 답변이 늦어서 죄송합니다. 이 스 니펫을 여러 번 다시 작성했기 때문에 다른 검사의
일부일

16

이것은 일부 요소를 닫을 것입니다-더 넓은 범위의 컨트롤을 지원하려면 다음과 같이 확장해야합니다. 간단한 토론은 여기를보십시오

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

5
관례 적으로, 나는 어떤 Try*메소드도 리턴 bool하고 다음과 out같이 해당 유형을 리턴 하는 매개 변수를 가질 것으로 예상 한다.bool IDictionary.TryGetValue(TKey key, out TValue value)
Drew Noakes

@DrewNoakes 그렇다면 Philipp에게 무엇을 부르라고 제안하십니까? 또한 그러한 기대에도 불구하고 그의 코드는 명확하고 사용하기 쉽습니다.
ANeves

1
@ ANeves,이 경우에는 그냥 호출합니다 FindParent. 이 이름은 그것이 돌아올 수 있음을 의미합니다 null. Try*접두사는 내가 위에서 설명하는 방법으로 BCL 전반에 걸쳐 사용된다. 또한 여기에있는 다른 답변의 대부분은 Find*명명 규칙을 사용합니다 . 그래도 사소한 점입니다 :)
Drew Noakes

16

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

1
이 메소드를 전달하면 그렇지 DependencyObject않은 FrameworkElement경우 예외가 발생할 수 있습니다. 또한 루프 GetChildrenCount의 모든 반복에서 사용 for하는 것은 나쁜 생각처럼 들립니다.
Tim Pohlmann

1
글쎄, 이것은 5 년 전부터이므로 더 이상 작동하는지 모르겠습니다 :)
andresp

방금 그것에 대해 비틀 거 렸고 다른 사람들도 마찬가지 였기 때문에 방금 언급했습니다.)
Tim Pohlmann

13

일반적으로 재귀를 좋아하지만 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>();

9

다음은 계층으로 들어가는 깊이를 제어하면서 Type별로 컨트롤을 찾는 코드입니다 (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();
    }
}

9

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

8

다음과 같은 시퀀스 함수가 ​​있습니다 (완전히 일반적입니다).

    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, Where)를 사용할 수 있습니다.


6

질문은 매우 사소한 경우에 대한 답변을 찾는 사람들을 끌어 들이기에 충분할 정도로 일반적이므로, 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();
    }
}

또는 물론 아이들을 반복하는 명백한 for 루프.


3

이 옵션은 이미 C #에서 Visual Tree를 통과하는 것에 대해 설명합니다. RelativeSource 태그 확장을 사용하여 xaml의 시각적 트리를 탐색 할 수 있습니다. msdn

종류별로 찾기

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

2

유연한 술어를 사용하는 솔루션은 다음과 같습니다.

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;

1

이 코드는 @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;
    }  

당신은 (당신이 통과 할 때 이런 유형이 일치되지만 이름은하지 재귀 경우 메소드를 호출 계속 필요 FrameworkElementT). 그렇지 않으면 돌아올 null것이고 잘못되었습니다.


0

코드에서 주어진 유형의 조상을 찾으려면 다음을 사용할 수 있습니다.

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

-5

이 시도

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

뒤에 코드

var txtblock = sender as Textblock;
txtblock.Foreground = "Red"
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.