VisualState Class
Collapse the table of content
Expand the table of content

VisualState Class

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

Represents the visual appearance of the control when it is in a specific state.


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

<ContentPropertyAttribute("Storyboard", True)> _
Public NotInheritable Class VisualState _
	Inherits DependencyObject
<VisualState .../>

The VisualState type exposes the following members.

Public methodVisualStateInitializes a new instance of the VisualState class.

Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertyNameGets the name of the VisualState.
Public propertyStoryboardGets or sets a Storyboard that defines the appearance of the control when it is the state that is represented by the VisualState.

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

A VisualState specifies how the control looks when it is in a certain state. For example, when a Button is pressed, its border might be a different color than normal. The VisualState class has a Storyboard property that changes the appearance of the control. When the control enters the state that is specified by the VisualState.Name property, the Storyboard begins. When the control exits the state, the Storyboard stops.

The VisualStateGroup.States property contains VisualState objects. VisualStateGroup objects are added to the VisualStateManager.VisualStateGroups and are defined in the control's ControlTemplate.

Control authors use the VisualStateManager to transition between states by passing the name of VisualState objects to the GoToState method.

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