Export (0) Print
Expand All

Keyboard.IsKeyToggled Method

Determines whether the specified key is toggled.

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

public static bool IsKeyToggled(
	Key key
)

Parameters

key
Type: System.Windows.Input.Key

The specified key.

Return Value

Type: System.Boolean
true if key is in the toggled state; otherwise, false.

The GetKeyStates method can be used to determine the set of states of a specific key.

The following example shows how to use the IsKeyToggled method to determine the state of a specific key. The Return key is passed to the IsKeyToggled method. If the method returns true, then the background of a Button is changed.

// Uses the Keyboard.IsToggled to determine if a key is toggled. 
if (Keyboard.IsKeyToggled(Key.Return))
{
    btnIsToggle.Background = Brushes.Red;
}
else
{
    btnIsToggle.Background = Brushes.AliceBlue;
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft