KeyStates KeyStates KeyStates KeyStates Enum

Definition

Specifies constants that define the state of a key.

This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.

public enum class KeyStates
[System.Flags]
public enum KeyStates
type KeyStates = 
Public Enum KeyStates
Inheritance
Attributes

Fields

Down Down Down Down 1

The key is pressed.

None None None None 0

The key is not pressed.

Toggled Toggled Toggled Toggled 2

The key is toggled.

Examples

The following example changes the color of a Button if the Toggled of the key passed in the KeyEventArgs is Down. The state of the key is determined by using a bitwise AND operation. The same technique can be used to determine whether a key has multiple states, such as being in the Toggled state and the Down state.

// A bitwise AND operation is used in the comparison.
// e is an instance of KeyEventArgs.
// btnDown is a Button.
if ((e.KeyStates & KeyStates.Down) > 0)
{
    btnDown.Background = Brushes.Red;
}
' A bitwise AND operation is used in the comparison.
' e is an instance of KeyEventArgs.
' btnDown is a Button.
If (e.KeyStates And KeyStates.Down) > 0 Then
	btnDown.Background = Brushes.Red

Remarks

The KeyStates class is a bit field (flagwise) enumeration. Therefore, a key can be in multiple states. For example, a key could be in the Down state as well as in the Toggled state. Use bit operations to determine the exact state or states the key is in.

Applies to

See also