ControlTemplate Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.FrameworkTemplate
      System.Windows.Controls.ControlTemplate

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

Syntax

'Declaration
Public NotInheritable Class ControlTemplate _
    Inherits FrameworkTemplate

public sealed class ControlTemplate : FrameworkTemplate

<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 type exposes the following members.

Constructors

	Name	Description
	ControlTemplate	Initializes a new instance of the ControlTemplate class.

Top

Properties

	Name	Description
	Dispatcher	Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
	TargetType	Gets or sets the type to which the ControlTemplate is applied.

Top

Methods

	Name	Description
	CheckAccess	Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
	ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetAnimationBaseValue	Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
	SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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

Examples

The following example creates a simple ControlTemplate for a Button. The control template 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">
  <Grid >
    <VisualStateManager.VisualStateGroups>
      <VisualStateGroup x:Name="CommonStates">

        <VisualStateGroup.Transitions>

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

        <VisualState x:Name="Normal" />

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

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

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

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Windows.Controls Namespace

Control

Other Resources

Creating a New Control by Creating a ControlTemplate