2 out of 2 rated this helpful Rate this topic

VisualStateManager Class

Silverlight

Other Versions

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

Inheritance Hierarchy

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

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

Syntax

Copy

public class VisualStateManager : DependencyObject

XAML Object Element Usage

Copy

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

Constructors

	Name	Description
	VisualStateManager	Initializes a new instance of the VisualStateManager class.

Top

Properties

	Name	Description
	Dispatcher	Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)

Top

Attached Properties

	Name	Description
	CustomVisualStateManager	Gets or sets the VisualStateManager that transitions between the states of a control.

Top

Methods

	Name	Description
	CheckAccess	Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
	ClearValue	Clears the local value of a dependency property. (Inherited from DependencyObject.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetAnimationBaseValue	Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
	GetCustomVisualStateManager	Gets the value of the CustomVisualStateManager attached property.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
	GetVisualStateGroups	Gets the value of the VisualStateManager.VisualStateGroups attached property.
	GoToState	Transitions the control between two states.
	GoToStateCore	Transitions a control between states.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RaiseCurrentStateChanged	Raises the CurrentStateChanged event on the specified VisualStateGroup.
	RaiseCurrentStateChanging	Raises the CurrentStateChanging event on the specified VisualStateGroup.
	ReadLocalValue	Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
	SetCustomVisualStateManager	Sets the value of the CustomVisualStateManager attached property.
	SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	CustomVisualStateManagerProperty	Identifies the CustomVisualStateManager dependency property.

Top

Remarks

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.

Examples

The following example creates a simple ControlTemplate for a Button that contains one Grid. The example sets the VisualStateManager.VisualStateGroups property on the Grid. The VisualStateManager.VisualStateGroups contains one VisualStateGroup, called CommonStates, which defines the MouseOver and Normal VisualState objects. When the user puts the mouse over the Button, the Grid changes from green to red over one half second. When the user moves the mouse away from the button, the Grid immediately changes back to green.

Run this sample

XAML

Copy


<ControlTemplate TargetType="Button">
  <Grid >
    <VisualStateManager.VisualStateGroups>
      <VisualStateGroup x:Name="CommonStates">

        <VisualStateGroup.Transitions>

          <!--Take one half second to trasition to the MouseOver state.-->
          <VisualTransition To="MouseOver" 
                              GeneratedDuration="0:0:0.5"/>
        </VisualStateGroup.Transitions>

        <VisualState x:Name="Normal" />

        <!--Change the SolidColorBrush, ButtonBrush, to red when the
            mouse is over the button.-->
        <VisualState x:Name="MouseOver">
          <Storyboard>
            <ColorAnimation Storyboard.TargetName="ButtonBrush" 
                            Storyboard.TargetProperty="Color" To="Red" />
          </Storyboard>
        </VisualState>
      </VisualStateGroup>
    </VisualStateManager.VisualStateGroups>
    <Grid.Background>
      <SolidColorBrush x:Name="ButtonBrush" Color="Green"/>
    </Grid.Background>
  </Grid>
</ControlTemplate>