VisualStateManager Class

July 28, 2014

Manages states and the logic for transitioning between states for controls.

System.Object
  System.Windows.DependencyObject
    System.Windows.VisualStateManager

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

public class VisualStateManager : DependencyObject
<templateRoot>
  <VisualStateManager.VisualStateGroups>
    oneOrMoreVisualStateGroups
  </VisualStateManager.VisualStateGroups>
</templateRoot>

XAML Values

templateRoot

The root UIElement of content for a template applied to a control.

oneOrMoreVisualStateGroups

One or more object elements that are of type VisualStateGroup.

The VisualStateManager type exposes the following members.

  NameDescription
Public methodVisualStateManagerInitializes a new instance of the VisualStateManager class.
Top

  NameDescription
Public propertyDispatcherGets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Top

  NameDescription
Public attached propertyCustomVisualStateManagerGets or sets the VisualStateManager that transitions between the states of a control.
Top

  NameDescription
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 methodStatic memberGetCustomVisualStateManagerGets the value of the CustomVisualStateManager attached property.
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.)
Public methodStatic memberGetVisualStateGroupsGets the value of the VisualStateManager.VisualStateGroups attached property.
Public methodStatic memberGoToStateTransitions the control between two states.
Protected methodGoToStateCoreTransitions a control between states.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodRaiseCurrentStateChangedRaises the CurrentStateChanged event on the specified VisualStateGroup.
Protected methodRaiseCurrentStateChangingRaises the CurrentStateChanging event on the specified VisualStateGroup.
Public methodReadLocalValueReturns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodStatic memberSetCustomVisualStateManagerSets the value of the CustomVisualStateManager attached property.
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.)
Top

  NameDescription
Public fieldStatic memberCustomVisualStateManagerPropertyIdentifies the CustomVisualStateManager dependency property.
Top

Template authors add VisualStateGroup objects the VisualStateManager.VisualStateGroups attached property to represent states of a control and Control authors transition between states by calling the GoToState method.

If you want to implement your own logic for transitioning between states, you must inherit from VisualStateManager, override the GoToStateCore method, and set the VisualStateManager.CustomVisualStateManager attached property on the control that uses the custom logic.

The VisualStateManager.VisualStateGroups Attached Property

The VisualStateManager.VisualStateGroups attached property contains VisualStateGroup objects. Each VisualStateGroup contains a collection of mutually exclusive VisualState objects. You set VisualStateManager.VisualStateGroups on the root element of a ControlTemplate. Setting VisualStateManager.VisualStateGroups is the usage shown as the XAML usage for this class.

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.

Show:
© 2014 Microsoft