How do I access an element of a control template from within code-behind

Locksleyu picture Locksleyu · Nov 14, 2011 · Viewed 52.1k times · Source

I'm trying to access a user control which is inside the control template of a content control. Specifically:

  <ContentControl x:Name="MyList" >
        <ContentControl.Template>
            <ControlTemplate x:Name="MyControlTemplate">
                <Border RenderTransformOrigin="0,0" x:Name="border">
                    <UserControls:MyControl x:Name="MyControlName" Width="100" ViewModel="{Binding}" />

I can access this.MyList but it says this.MyControlName is not found. How do I access the MyControlName object from code-behind in this situation?

Thanks!

Answer

H.B. picture H.B. · Nov 14, 2011

You need to get the template and locate the control by name on the templated control, something like:

var template = MyList.Template;
var myControl = (MyControl)template.FindName("MyControlName", MyList);

Templates are just that: Abstract descriptions of what is to be created, the controls in templates only exist in the context of something that is being templated.


Note that you should only ever access the elements within a control template if you are authoring the control that the template is for. Access from outside should be done via bound properties and methods.

For data templates this is similar. All the things you need to access should be bound to an object and access should then be through said object. This is especially true in cases of item controls which virtualize their items, so the elements do not even exist most of the time.