Keyboard.IsKeyDown(Key) Method

Reference

Definition

Namespace:: System.Windows.Input

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Determines whether the specified key is pressed.

public:
 static bool IsKeyDown(System::Windows::Input::Key key);

public static bool IsKeyDown(System.Windows.Input.Key key);

static member IsKeyDown : System.Windows.Input.Key -> bool

Public Shared Function IsKeyDown (key As Key) As Boolean

Parameters

key: Key

The specified key.

Returns

Boolean

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

Examples

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;
}
else
{
    btnIsDown.Background = Brushes.AliceBlue;
}

' Uses the Keyboard.IsKeyDown to determine if a key is down.
' e is an instance of KeyEventArgs.
If Keyboard.IsKeyDown(Key.Return) Then
    btnIsDown.Background = Brushes.Red
Else
    btnIsDown.Background = Brushes.AliceBlue
End If

Remarks

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

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via