Skip to content

Latest commit

 

History

History
37 lines (25 loc) · 1.67 KB

visualstate_name.md

File metadata and controls

37 lines (25 loc) · 1.67 KB
-api-id -api-type
P:Windows.UI.Xaml.VisualState.Name
winrt property

Windows.UI.Xaml.VisualState.Name

-description

Gets the name of the VisualState.

-xaml-syntax

<VisualState x:Name="stateName"/>

-xaml-values

stateName
stateNameThe name of the VisualState. Name is a read-only property. You specify the name of the VisualState by setting the x:Name attribute. An unprefixed string Name won't work.
## -property-value The name of the [VisualState](visualstate.md).

-remarks

Name is a read-only property that you can check with code at run-time to read the value of the x:Name attribute that was applied to a VisualState in a XAML control template. You can't literally set Name because it's read-only, and x:Name attribute can only be set in XAML. The value is available as soon as the XAML that contains the control template and the VisualState definition is loaded.

The need to check the Name of a VisualState at run-time is anticipated to be relatively uncommon, and would only be relevant to advanced scenarios. For the most part, the definition of a VisualState in XAML combined with using VisualStateManager and VisualStateGroup events in code provides you all that you need to define and invoke visual states for a custom or Windows Runtime-defined control.

-examples

-see-also

x:Name attribute