IsToggled Property
Collapse the table of content
Expand the table of content

KeyEventArgs.IsToggled Property

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

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

© 2016 Microsoft