Click to Rate and Give Feedback
MSDN
MSDN Library
Web Development
Silverlight 3

  Switch on low bandwidth view
This page is specific to
Microsoft Silverlight 3

Other versions are also available for the following:
.NET Framework Class Library for Silverlight
ControlTemplate Class

Defines the element tree that is applied as a control template.

Namespace:  System.Windows.Controls
Assembly:  System.Windows (in System.Windows.dll)
Visual Basic (Declaration)
Public NotInheritable Class ControlTemplate _
    Inherits FrameworkTemplate
Visual Basic (Usage)
Dim instance As ControlTemplate
C#
public sealed class ControlTemplate : FrameworkTemplate
XAML Object Element Usage
<ControlTemplate ...>
  templateRootElement
</ControlTemplate>

XAML Values

templateRootElement

A single object element that derives from FrameworkElement. The templateRootElement is often a panel that contains other element.

The ControlTemplate defines the control's appearance, which is usually a composite of multiple elements.

If you are defining a control template that is intended to replace the template of an existing control class, then the XAML that you use to define the control template content should match the existing control contract. Otherwise, the control may not function correctly in the UI. For more information, see Customizing the Appearance of an Existing Control by Using a ControlTemplate and Control Styles and Templates.

If you create a new control class that uses a ControlTemplate, you should use the control parts model so that you control will behave correctly when someone replaces the ControlTemplate of your control. For more information, see Creating a New Control by Creating a ControlTemplate.

In Silverlight 2, control templating is entirely done by defining XAML. The API surface of FrameworkTemplate and ControlTemplate is not intended for and is not capable of defining templates for a control by creating a ControlTemplate in code.

The following example creates a simple ControlTemplate for a Button. The controltemplate contains one Grid and specifies the following behavior:

  • When the user puts the mouse over the Button, the Grid changes from green to red over one half second.

  • When the user moves the mouse away from the button, the Grid immediately changes back to green.

<ControlTemplate TargetType="Button"
                 xmlns:vsm="clr-namespace:System.Windows;assembly=System.Windows">
  <Grid >
    <vsm:VisualStateManager.VisualStateGroups>
      <vsm:VisualStateGroup x:Name="CommonStates">

        <vsm:VisualStateGroup.Transitions>

          <!--Take one half second to trasition to the MouseOver state.-->
          <vsm:VisualTransition To="MouseOver" 
                              GeneratedDuration="0:0:0.5"/>
        </vsm:VisualStateGroup.Transitions>

        <vsm:VisualState x:Name="Normal" />

        <!--Change the SolidColorBrush, ButtonBrush, to red when the
            mouse is over the button.-->
        <vsm:VisualState x:Name="MouseOver">
          <Storyboard>
            <ColorAnimation Storyboard.TargetName="ButtonBrush" 
                            Storyboard.TargetProperty="Color" To="Red" />
          </Storyboard>
        </vsm:VisualState>
      </vsm:VisualStateGroup>
    </vsm:VisualStateManager.VisualStateGroups>
    <Grid.Background>
      <SolidColorBrush x:Name="ButtonBrush" Color="Green"/>
    </Grid.Background>
  </Grid>
</ControlTemplate>

System..::.Object
  System.Windows..::.DependencyObject
    System.Windows..::.FrameworkTemplate
      System.Windows.Controls..::.ControlTemplate
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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