ControlTemplate class

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

Inheritance

Object

  DependencyObject

    FrameworkTemplate

      ControlTemplate

Syntax

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

Attributes

ActivatableAttribute(NTDDI_WIN8)

MarshalingBehaviorAttribute(Agile)

ThreadingAttribute(Both)

VersionAttribute(NTDDI_WIN8)

WebHostHiddenAttribute()

Members

The ControlTemplate class has these types of members:

• Constructors
• Methods
• Properties

Constructors

The ControlTemplate class has these constructors.

Methods

The ControlTemplate class has these methods. It also inherits methods from the Object class.

Properties

The ControlTemplate class has these properties.

Remarks

The content of a template such as ControlTemplate or DataTemplate is not accessible through a simple run-time API. Defining a template is a scenario for XAML language usage, and the value is assigned purely as a XAML parsing operation. There are ways to access template content after it is applied to a specific control; see OnApplyTemplate or GetTemplateChild.

Examples

The following example creates a simple ControlTemplate for a Button. The control template contains one Grid and specifies this 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 transition to the PointerOver state.-->
          <VisualTransition To="PointerOver" 
                              GeneratedDuration="0:0:0.5"/>
        </VisualStateGroup.Transitions>
        
        <VisualState x:Name="Normal" />

        <!--Change the SolidColorBrush, ButtonBrush, to red when the
            Pointer is over the button.-->
        <VisualState x:Name="PointerOver">
          <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>

Requirements

See also

FrameworkTemplate

Build date: 3/12/2013