This documentation is archived and is not being maintained.

Keyboard.IsKeyDown Method

Determines whether or not the specified key is pressed.

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

public static bool IsKeyDown (
	Key key
public static boolean IsKeyDown (
	Key key
public static function IsKeyDown (
	key : Key
) : boolean
You cannot use methods in XAML.



The specified key.

Return Value

true if key is in the down state; otherwise, false.

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

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

// Uses the Keyboard.IsKeyDown to determine if a key is down.
// e is an instance of KeyEventArgs.
if (Keyboard.IsKeyDown(Key.Return))
    btnIsDown.Background = Brushes.Red;
    btnIsDown.Background = Brushes.AliceBlue;

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0