This documentation is archived and is not being maintained.

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; }
Members of this class are either not typically used in XAML, or cannot be used in XAML.

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;
}

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

.NET Framework

Supported in: 3.5, 3.0
Show: