LogicalTreeHelper.FindLogicalNode Method

Attempts to find and return an object that has the specified name. The search starts from the specified object and continues into subnodes of the logical tree.

Namespace:  System.Windows
Assembly:  PresentationFramework (in PresentationFramework.dll)

public static DependencyObject FindLogicalNode(
	DependencyObject logicalTreeNode,
	string elementName
)

Parameters

logicalTreeNode
Type: System.Windows.DependencyObject

The object to start searching from. This object must be either a FrameworkElement or a FrameworkContentElement.

elementName
Type: System.String

The name of the object to find.

Return Value

Type: System.Windows.DependencyObject
The object with the matching name, if one is found; returns null if no matching name was found in the logical tree.

The methods FrameworkContentElement.FindName and FrameworkElement.FindName are superficially similar to FindLogicalNode, but operate by different logic:

  • The search direction for FindLogicalNode is toward child objects (down the tree); the search direction for the FindName methods is towards parent objects (up the tree).

  • The FindName methods are governed by the concept of a XAML namescope. Using FindName you are guaranteed that only one object of that name exists, because XAML namescopes enforce uniqueness. In contrast, FindLogicalNode ignores XAML namescope and might cross XAML namescope boundaries during the search. As such, there is no guarantee of uniqueness of the elementName name once boundaries are crossed. For more information about XAML namescopes, see WPF XAML Namescopes.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft