名前またはタイプで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");

Note Application.Current.MainWindowは任意の親ウィンドウにすることができます。


@CrimsonX:たぶん私はこれを間違っています... ContentControl(Expander)内のコントロール(ListBox)に到達する必要があるのと同じようなニーズがありました。上記のコードはそのままでは機能しませんでした。リーフノード(GetChildrenCount => 0)がContentControlかどうかを確認するために、上記のコードを更新する必要がありました。はいの場合、コンテンツが名前とタイプの基準に一致するかどうかを確認します。
Gishu

@Gishu-私はそれがこの目的のために働くべきだと思います。コードをコピーして貼り付けて、通話の使い方を示すことはできますか?FindChild <ListBox>(Expander myExpanderName、 "myListBoxName")になるはずです。
CrimsonX 2010年

3
@CrimsonX別のコーナーケースを見つけたと思います。RibbonApplicationMenuItemでPART_SubmenuPlaceholderを見つけようとしましたが、上記のコードが機能しませんでした。それを解決するには、以下を追加する必要があります。if(name == ElementName)else {foundChild = FindChild(child、name)if(foundChild!= null)break; }
kevindaub

6
注意してください、答えにはバグがあります。検索されたタイプの子に到達するとすぐに停止します。他の回答を検討/優先する必要があると思います。
Eric Ouellet、2014

2
このコードはすばらしいですが、特定のタイプの要素を探していない場合は機能しません。たとえば、FrameworkElementTとして渡した場合、最初のループが終了するとすぐにnullを返します。そのため、いくつかの変更が必要になります。
Amir Oveisi 2017年

131

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

与えられた:

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

分離コードファイルでは、次のように記述できます。

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

もちろん、それはx:Nameを使用して定義されているため、生成されたフィールドを参照することもできますが、静的ではなく動的に検索したい場合があります。

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


6
これが機能するために、必ずしも「x:」をname属性に追加する必要はありません。
ブライアンバック'19

3
これは常に機能するとは限りません。プロパティウィンドウのコンテンツとして、入れ子になったグリッドでプログラムによって結合されたUserControlがあります。ただし、CrimsonXの答えは問題なく機能します。
マット

4
これは、などItemControls内の要素、リストボックス、のために動作しません
ソレンセン

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 2018年

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

コードの拡張。

  • タイプ、タイプ、および基準(述語)で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


-1まさに私が実装しようとしていたもの(述語、反復子、および拡張メソッド)ですが、ソースリンクには404があります。ここにコードが含まれている場合、またはソースリンクが修正されている場合、+ 1に変更されます!
cod3monk3y 2014

@ 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を返しますロードされている
クラウスNji

@UrbanEsc、なぜもう一度キャストchildするのですか?childTypeタイプがある場合Tifyield return childType...の中に書くことができますか?
Massimiliano Kraus

@MassimilianoKrausお返事が遅くなってすみませんが、あなたは正しいです。このスニペットを何度か書き換えたことが原因であると考えられるため、これは別のチェックの断片である可能性があります
UrbanEsc

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)
ドリューNoakes

@DrewNoakesそれでは、フィリップにそれを何と呼ぶように勧めますか?また、そのような期待があったとしても、私は彼のコードを明確かつ明確に使用できることがわかりました。
ANeves 2014

1
@ANeves、この場合、私はそれを呼び出すだけFindParentです。私にとってこの名前は、それが戻る可能性があることを意味しnullます。Try*接頭辞は、私は上記の説明のようにBCL全体で使用されます。また、ここでの他の回答のほとんどはFind*命名規則を使用していることに注意してください。しかしそれはマイナーなポイントです:)
ドリュー・ノークス2014

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
このメソッドを渡した場合DependencyObjectFrameworkElementそれは例外ではありません。またGetChildrenCountforループのすべての反復で使用することは悪い考えのように思えます。
Tim Pohlmann、2015

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

励起子80 ...私はあなたのコードがユーザーコントロールを介して再帰しないことに問題がありました。グリッドルートにヒットし、エラーをスローしていました。私はこれが私のためにそれを修正すると信じています:

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

またはもちろん、Children上で反復する明白なforループです。


3

これらのオプションは、C#でのビジュアルツリーのトラバースについてすでに説明しています。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回答のバグを修正するだけです。

 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あり、それは間違っています。


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.