This documentation is archived and is not being maintained.

FrameworkTemplate.FindName Method

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

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

'Declaration
Public Function FindName ( _
	name As String, _
	templatedParent As FrameworkElement _
) As Object

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 "XAML Namescopes in Styles and Templates" in WPF XAML 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:


<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:


<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.


			' Getting the currently selected ListBoxItem
			' Note that the ListBox must have
			' IsSynchronizedWithCurrentItem set to True for this to work
			Dim myListBoxItem As ListBoxItem = CType(myListBox.ItemContainerGenerator.ContainerFromItem(myListBox.Items.CurrentItem), ListBoxItem)

			' Getting the ContentPresenter of myListBoxItem
			Dim myContentPresenter As ContentPresenter = FindVisualChild(Of ContentPresenter)(myListBoxItem)

			' Finding textBlock from the DataTemplate that is set on that ContentPresenter
			Dim myDataTemplate As DataTemplate = myContentPresenter.ContentTemplate
			Dim myTextBlock As TextBlock = CType(myDataTemplate.FindName("textBlock", myContentPresenter), TextBlock)

			' 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:


		Private Function FindVisualChild(Of childItem As DependencyObject)(ByVal obj As DependencyObject) As childItem
			For i As Integer = 0 To VisualTreeHelper.GetChildrenCount(obj) - 1
				Dim child As DependencyObject = VisualTreeHelper.GetChild(obj, i)
				If child IsNot Nothing AndAlso TypeOf child Is childItem Then
					Return CType(child, childItem)
				Else
					Dim childOfChild As childItem = FindVisualChild(Of childItem)(child)
					If childOfChild IsNot Nothing Then
						Return childOfChild
					End If
				End If
			Next i
			Return Nothing
		End Function


More Code

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

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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