Keyboard.IsKeyToggled Method (Key)

 

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
Available since 3.0
Return to top
Show: