Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 3.5
 FindName Method
This page is specific to
Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:
.NET Framework Class Library
FrameworkTemplate..::.FindName Method

Updated: November 2007

Finds the element associated with the specified name defined within this template.

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

Visual Basic (Declaration)
Public Function FindName ( _
    name As String, _
    templatedParent As FrameworkElement _
) As Object
Visual Basic (Usage)
Dim instance As FrameworkTemplate
Dim name As String
Dim templatedParent As FrameworkElement
Dim returnValue As Object

returnValue = instance.FindName(name, _
    templatedParent)
C#
public Object FindName(
    string name,
    FrameworkElement templatedParent
)
Visual C++
public:
Object^ FindName(
    String^ name, 
    FrameworkElement^ templatedParent
)
J#
public Object FindName(
    String name,
    FrameworkElement templatedParent
)
JScript
public function FindName(
    name : String, 
    templatedParent : FrameworkElement
) : Object
XAML
You cannot use methods in XAML.

Parameters

name
Type: System..::.String

The string name.

templatedParent
Type: System.Windows..::.FrameworkElement

The context of the FrameworkElement where this template is applied.

Return Value

Type: System..::.Object

The element associated with the specified name.

For more information, see "Namescopes in Styles and Templates" in WPF Namescopes.

This example shows how to find elements that are generated by a DataTemplate.

In this example, there is a ListBox that is bound to some XML data:

C#
<ListBox Name="myListBox" ItemTemplate="{StaticResource myDataTemplate}"
         IsSynchronizedWithCurrentItem="True">
  <ListBox.ItemsSource>
    <Binding Source="{StaticResource InventoryData}" XPath="Books/Book"/>
  </ListBox.ItemsSource>
</ListBox>

The ListBox uses the following DataTemplate:

C#
<DataTemplate x:Key="myDataTemplate">
  <TextBlock Name="textBlock" FontSize="14" Foreground="Blue">
    <TextBlock.Text>
      <Binding XPath="Title"/>
    </TextBlock.Text>
  </TextBlock>
</DataTemplate>

If you want to retrieve the TextBlock element generated by the DataTemplate of a certain ListBoxItem, you need to get the ListBoxItem, find the ContentPresenter within that ListBoxItem, and then call FindName on the DataTemplate that is set on that ContentPresenter. The following example shows how to perform those steps. For demonstration purposes, this example creates a message box that shows the text content of the DataTemplate-generated text block.

C#
// Getting the currently selected ListBoxItem
// Note that the ListBox must have
// IsSynchronizedWithCurrentItem set to True for this to work
ListBoxItem myListBoxItem =
    (ListBoxItem)(myListBox.ItemContainerGenerator.ContainerFromItem(myListBox.Items.CurrentItem));

// Getting the ContentPresenter of myListBoxItem
ContentPresenter myContentPresenter = FindVisualChild<ContentPresenter>(myListBoxItem);

// Finding textBlock from the DataTemplate that is set on that ContentPresenter
DataTemplate myDataTemplate = myContentPresenter.ContentTemplate;
TextBlock myTextBlock = (TextBlock)myDataTemplate.FindName("textBlock", myContentPresenter);

// Do something to the DataTemplate-generated TextBlock
MessageBox.Show("The text of the TextBlock of the selected list item: "
    + myTextBlock.Text);

The following is the implementation of FindVisualChild, which uses the VisualTreeHelper methods:

C#
private childItem FindVisualChild<childItem>(DependencyObject obj)
    where childItem : DependencyObject
{
    for (int i = 0; i < VisualTreeHelper.GetChildrenCount(obj); i++)
    {
        DependencyObject child = VisualTreeHelper.GetChild(obj, i);
        if (child != null && child is childItem)
            return (childItem)child;
        else
        {
            childItem childOfChild = FindVisualChild<childItem>(child);
            if (childOfChild != null)
                return childOfChild;
        }
    }
    return null;
}

For the complete sample, see Finding Template-Generated Elements Sample.

More Code

How to: Find ControlTemplate-Generated Elements This example shows how to find elements that are generated by a ControlTemplate.

Windows Vista

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

.NET Framework

Supported in: 3.5, 3.0
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2008 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker