VisualStateGroup.CurrentState Property

Definition

Namespace:

Windows.UI.Xaml

Gets the most recently set VisualState from a successful call to the GoToState method.

public:
 property VisualState ^ CurrentState { VisualState ^ get(); };

VisualState CurrentState();

public VisualState CurrentState { get; }

var visualState = visualStateGroup.currentState;

Public ReadOnly Property CurrentState As VisualState

Property Value

VisualState

The most recently set VisualState from a successful call to the GoToState method, or null.

Remarks

If GoToState has never been called for the states in a particular VisualStateGroup, CurrentState is null. With correct design of controls and visual state, this shouldn't happen. The control logic for a control should always be able to select one state from a given VisualStateGroup, even if that state is a named state with no specific storyboarded behavior.

Because there are potentially multiple VisualStateGroup sets of visual states for a control, each such VisualStateGroup can report a CurrentState. For example, if you click on a Button with a default control template, the "CommonStates" VisualStateGroup reports a CurrentState of "Pressed", and the "FocusStates" VisualStateGroup reports a CurrentState of "PointerFocused".

See also

• VisualState
• GoToState(Control, String, Boolean)
• CurrentStateChanged
• Quickstart: Control templates