TemplateVisualStateAttribute Class
Collapse the table of content
Expand the table of content

TemplateVisualStateAttribute Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Specifies that a control can be in a certain state and that a VisualState is expected in the control's ControlTemplate.


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

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = true)]
public sealed class TemplateVisualStateAttribute : Attribute

The TemplateVisualStateAttribute type exposes the following members.

Public methodTemplateVisualStateAttributeInitializes a new instance of the TemplateVisualStateAttribute class.

Public propertyGroupNameGets or sets the name of the group that the state belongs to.
Public propertyNameGets or sets the name of the state that the control can be in.

Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Control authors that use the parts control model apply this attribute to the class definition of a control class to inform template authors what states the control can be in. The states that are specified by the TemplateVisualStateAttribute are part of the control contract ControlTemplate authors add VisualState objects to the template to specify the appearance of a control when it is in a certain state. States that share the same GroupName are mutually exclusive and are defined in a single VisualStateGroup in the ControlTemplate.

The following example shows the states that are specified for the Button.

[TemplateVisualState(Name = "Normal", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Pressed", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Disabled", GroupName = "CommonStates")]
[TemplateVisualState(Name = "Unfocused", GroupName = "FocusStates")]
[TemplateVisualState(Name = "Focused", GroupName = "FocusStates")]
public class Button : ButtonBase

The following example defines the VisualState objects for the Normal, MouseOver, and Pressed states, which are all in the CommonStates group. The Disabled state and the states in the FocusStates group are omitted to keep the example short.

<ControlTemplate TargetType="Button">
  <Border x:Name="RootElement">


      <!--Define the states for the common states.
          The states in the VisualStateGroup are mutually exclusive to
          each other.-->
      <VisualStateGroup x:Name="CommonStates">

        <!--The Normal state is the state the button is in
            when it is not in another state from this VisualStateGroup.-->
        <VisualState x:Name="Normal" />

        <!--Change the SolidColorBrush, BorderBrush, to red when the
            mouse is over the button.-->
        <VisualState x:Name="MouseOver">
            <ColorAnimation Storyboard.TargetName="BorderBrush" 
                              Storyboard.TargetProperty="Color" To="Red" />



        <!--Change the SolidColorBrush, BorderBrush, to Transparent when the
            button is pressed.-->
        <VisualState x:Name="Pressed">
          <Storyboard >
            <ColorAnimation Storyboard.TargetName="BorderBrush" 
                              Storyboard.TargetProperty="Color" To="Transparent"/>
          <!--The Disabled state is omitted for brevity.-->


      <SolidColorBrush x:Name="BorderBrush" Color="Black"/>

    <Grid Background="{TemplateBinding Background}" Margin="4">
        HorizontalAlignment="{TemplateBinding HorizontalContentAlignment}"
        VerticalAlignment="{TemplateBinding VerticalContentAlignment}"
        Margin="4,5,4,4" />



Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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

© 2018 Microsoft