KeyEventArgs.IsToggled Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Gets a value that indicates whether the key referenced by the event is in the toggled state.

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

public bool IsToggled { get; }

Property Value

Type: System.Boolean

true if the key is toggled; otherwise, false. There is no default value.

The Keyboard class also provides information about the state of the keys on the keyboard. For instance, the IsKeyToggled method returns whether a specified key is toggled.

The following example checks whether the key associated with an instance of KeyEventArgs is toggled by obtaining the state of the IsToggled property.

// e is a instance of KeyEventArgs.
// btnIsToggled is a Button.
if (e.IsToggled)
    btnIsToggle.Background = Brushes.Red;

.NET Framework
Available since 3.0
Return to top