webdevqa.jp.net

名前または種類でWPFコントロールを見つける方法はありますか。

与えられた名前またはタイプに一致するコントロールをWPFコントロール階層で検索する必要があります。これどうやってするの?

251
alex2k8

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は、任意の親ウィンドウにすることができます。

294
CrimsonX

FrameworkElement.FindName(string) を使って名前で要素を見つけることもできます。

与えられた:

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

分離コードファイルでは、次のように書くことができます。

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

もちろん、これはx:Nameを使って定義されているので、生成されたフィールドを参照するだけでも構いませんが、おそらく静的にではなく動的に検索したいでしょう。

この方法は、名前付きアイテムが複数回表示されるテンプレートでも使用できます(テンプレートの使用ごとに1回)。

119
Drew Noakes

コントロールを見つけるために 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);
65
John Myczek

私は他の人全員を繰り返しているだけかもしれませんが、タイプと名前であなたを子供にする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;
    }
}

あなたがそれが有用であることを願ってください。

20
Tri Q Tran

私のコードの拡張.

  • タイプ別、タイプ別および基準(述語)ごとに1人の子を検索し、その基準を満たすタイプのすべての子を検索するためのオーバーロードを追加しました。
  • 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

18
Gishu

特定の種類のすべてのコントロールを見つけたい場合は、このスニペットにも興味があるかもしれません。

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

私は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;
}
16
andresp

これはいくつかの要素を無視するでしょう - あなたはより幅広いコントロールをサポートするためにこのようにそれを拡張するべきです。簡単な議論のために、見てください ここ

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

私は一般的に再帰が大好きですが、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>();
12
Nathan Phillips

これは、階層の深さを制御しながら、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

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

私はこのようなシーケンス関数を持っています(これは完全に一般的です)。

    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)を使用できます。

8
VB Guy

この質問は非常に一般的なので、非常に些細なケースに対する答えを探している人々を引き付ける可能性があります。つまり、子孫ではなく子供だけが必要な場合は、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。

6
El Zorko

これらのオプションはすでにC#でビジュアルツリーをトラバースすることについて話しています。 RelativeSourceマークアップ拡張を使用してxamlでビジュアルツリーをトラバースすることも可能です。 msdn

タイプで探す

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

これは柔軟な述語を使う解決策です:

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;
2
Tim Pohlmann

このコードは@CrimsonX回答のバグを修正するだけです。

 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を返すつもりで、それは間違っています。

1
Amir Oveisi

コードから特定の型の先祖を見つけるには、次のようにします。

[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;
    }
}
0
Drew Noakes