VisualStateGroup Class
Collapse the table of content
Expand the table of content

VisualStateGroup Class

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

Contains mutually exclusive VisualState objects and VisualTransition objects that are used to go from one state to another.

Namespace:  System.Windows
Assembly:  System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.

<ContentPropertyAttribute("States", True)> _
Public NotInheritable Class VisualStateGroup _
	Inherits DependencyObject
   <VisualStateGroup ...>

The VisualStateGroup type exposes the following members.

Public methodVisualStateGroupInitializes a new instance of the VisualStateGroup class.

Public propertyCurrentStateGets the most recently set VisualState from a successful call to the GoToState method.
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyNameGets the name of the VisualStateGroup.
Public propertyStatesGets the collection of mutually exclusive VisualState objects.
Public propertyTransitionsGets the collection of VisualTransition objects.

Public methodCheckAccessDetermines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodClearValueClears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
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 methodGetAnimationBaseValueReturns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSetValueSets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public eventCurrentStateChangedOccurs after a control transitions into a different state.
Public eventCurrentStateChangingOccurs when a control begins transitioning into a different state.

ControlTemplate authors VisualState objects to a VisualStateGroup in a ControlTemplate to specify the visual behavior of the control. You put states that are mutually exclusive to each other in the same VisualStateGroup. For example, the CheckBox has two VisualStateGroup objects. One contains the states, Normal, Selected, Pressed, and Disabled. The other contains the states, Checked, UnChecked, and Indeterminate. The CheckBox can be in states Selected and UnChecked at the same time, but it cannot be in the Selected and Pressed states at the same time.

Control authors specify which states the control can be in by putting the TemplateVisualStateAttribute, on its class definition. States with the same TemplateVisualStateAttribute.GroupName belong in the same VisualStateGroup.

The Transitions property contains VisualTransition objects that are applied when the control transition between states that are defined in the VisualStateGroup.

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.

© 2017 Microsoft