TemplateVisualStateAttribute Class

Definition

Namespace:

System.Windows

Assembly:

PresentationFramework.dll

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

public ref class TemplateVisualStateAttribute sealed : Attribute

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

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true)>]
type TemplateVisualStateAttribute = class
    inherit Attribute

Public NotInheritable Class TemplateVisualStateAttribute
Inherits Attribute

Inheritance

Object

Attribute

TemplateVisualStateAttribute

Attributes

AttributeUsageAttribute

Examples

The following example shows the class signature for the NumericUpDown control. This example specifies that the NumericUpDown control uses four visual states. Two states, named Positive and Negative, are in the VisualStateGroup named ValueStates. The other two states, name Focused and Unfocused, are in the VisualStateGroup named FocusedStates. For the entire example, see Creating a Control That Has a Customizable Appearance.

[TemplatePart(Name = "UpButtonElement", Type = typeof(RepeatButton))]
[TemplatePart(Name = "DownButtonElement", Type = typeof(RepeatButton))]
[TemplateVisualState(Name = "Positive", GroupName = "ValueStates")]
[TemplateVisualState(Name = "Negative", GroupName = "ValueStates")]
[TemplateVisualState(Name = "Focused", GroupName = "FocusedStates")]
[TemplateVisualState(Name = "Unfocused", GroupName = "FocusedStates")]
public class NumericUpDown : Control

<TemplatePart(Name:="UpButtonElement", Type:=GetType(RepeatButton))> _
<TemplatePart(Name:="DownButtonElement", Type:=GetType(RepeatButton))> _
<TemplateVisualState(Name:="Positive", GroupName:="ValueStates")> _
<TemplateVisualState(Name:="Negative", GroupName:="ValueStates")> _
<TemplateVisualState(Name:="Focused", GroupName:="FocusedStates")> _
<TemplateVisualState(Name:="Unfocused", GroupName:="FocusedStates")> _
Public Class NumericUpDown
    Inherits Control

Remarks

Control authors use this attribute to specify the VisualState and VisualStateGroup objects that belong in their control's ControlTemplate. For example, suppose that you create a new control that has two visual states named Focused and Unfocused, both of which are in a VisualStateGroup named FocusStates. To specify to ControlTemplate authors that they can use those visual states, add two TemplateVisualStateAttribute attributes to the class signature of the control. Specify that the GroupName property is FocusStates and that the Name property is Focused for one and Unfocused for the other.

Constructors

TemplateVisualStateAttribute()

Initializes a new instance of the TemplateVisualStateAttribute class.

Properties

GroupName	Gets or sets the name of the group that the state belongs to.
Name	Gets or sets the name of the state that the control can be in.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)