特定の名前または型に一致するコントロールを WPF コントロール階層で検索する必要があります。これどうやってするの?
20 に答える
上記の John Myczek と Tri Q のアルゴリズムで使用されるテンプレート形式を組み合わせて、任意の親で使用できる findChild アルゴリズムを作成しました。ツリーを下方向に再帰的に検索すると、長いプロセスになる可能性があることに注意してください。私は WPF アプリケーションでこれをスポット チェックしただけです。見つけたエラーについてコメントしてください。コードを修正します。
WPF Snoopは、ビジュアル ツリーを確認するのに便利なツールです。このアルゴリズムをテストするか、作業をチェックする際に使用することを強くお勧めします。
Tri Q のアルゴリズムには小さなエラーがあります。子が見つかった後、childrenCount が > 1 の場合、もう一度反復すると、適切に見つかった子を上書きできます。したがってif (foundChild != null) break;
、この状態に対処するためにコードに a を追加しました。
/// <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");
NoteApplication.Current.MainWindow
は任意の親ウィンドウにすることができます。
FrameworkElement.FindName(string)を使用して、名前で要素を検索することもできます。
与えられた:
<UserControl ...>
<TextBlock x:Name="myTextBlock" />
</UserControl>
コードビハインドファイルには、次のように記述できます。
var myTextBlock = (TextBlock)this.FindName("myTextBlock");
もちろん、x:Nameを使用して定義されているため、生成されたフィールドを参照することもできますが、静的ではなく動的に検索することもできます。
このアプローチは、名前付きアイテムが複数回(テンプレートの使用ごとに1回)表示されるテンプレートでも使用できます。
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);
他の皆さんと同じことを繰り返しているだけかもしれませんが、型と名前で子を取得するメソッド 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);
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 = child;
break;
}
}
else
{
// child element found.
foundChild = child;
break;
}
}
}
return foundChild;
}
}
お役に立てば幸いです。
特定のタイプのすべてのコントロールを見つけたい場合は、このスニペットにも興味があるかもしれません
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;
}
}
}
コードの拡張機能。
- タイプ別、タイプ別および基準(述語)で1つの子を検索し、基準を満たすタイプのすべての子を検索するためのオーバーロードを追加しました
- FindChildrenメソッドは、DependencyObjectの拡張メソッドであることに加えて、イテレーターです。
- FindChildrenは、論理サブツリーもウォークします。ブログ投稿にリンクされているJoshSmithの投稿を参照してください。
ソース: 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
スーパークラスの型で動作していなかったので、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... ユーザーコントロールを再帰しないコードに問題がありました。Grid ルートにヒットし、エラーをスローしていました。私はこれが私のためにそれを修正すると信じています:
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());
}
Window でこれを呼び出して、すべてのコントロールを取得できます。
コレクションを取得したら、LINQ (つまり、OfType、Where) を使用できます。
この質問は非常に一般的であるため、非常に些細なケースへの回答を探している人を引き付ける可能性があります。子孫ではなく子だけが必要な場合は、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 ループ。
これらのオプションは、C# でのビジュアル ツリーのトラバースについて既に説明しています。RelativeSource マークアップ拡張機能を使用して、xaml のビジュアル ツリーをトラバースすることもできます。msdn
種類で探す
Binding="{Binding RelativeSource={RelativeSource Mode=FindAncestor, AncestorType={x:Type <TypeToFind>}}}"
これを試して
<TextBlock x:Name="txtblock" FontSize="24" >Hai Welcom to this page
</TextBlock>
コードビハインド
var txtblock = sender as Textblock;
txtblock.Foreground = "Red"