KeyStates Enum
Definition
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.
Specifies constants that define the state of a key.
This enumeration supports a bitwise combination of its member values.
public enum class KeyStates[System.Flags]
public enum KeyStates[<System.Flags>]
type KeyStates = Public Enum KeyStates- Inheritance
- Attributes
Fields
| Name | Value | Description |
|---|---|---|
| None | 0 | The key is not pressed. |
| Down | 1 | The key is pressed. |
| Toggled | 2 | The key is toggled. |
Examples
The following example changes the color of a Button if the KeyStates 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 (bitwise) 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.
