ConsoleKey Enum

Definition

Specifies the standard keys on a console.

public enum class ConsoleKey
[System.Serializable]
public enum ConsoleKey
type ConsoleKey = 
Public Enum ConsoleKey
Inheritance
ConsoleKey
Attributes

Fields

A 65

The A key.

Add 107

The Add key (the addition key on the numeric keypad).

Applications 93

The Application key (Microsoft Natural Keyboard).

Attention 246

The ATTN key.

B 66

The B key.

Backspace 8

The BACKSPACE key.

BrowserBack 166

The Browser Back key (Windows 2000 or later).

BrowserFavorites 171

The Browser Favorites key (Windows 2000 or later).

BrowserForward 167

The Browser Forward key (Windows 2000 or later).

BrowserHome 172

The Browser Home key (Windows 2000 or later).

BrowserRefresh 168

The Browser Refresh key (Windows 2000 or later).

BrowserSearch 170

The Browser Search key (Windows 2000 or later).

BrowserStop 169

The Browser Stop key (Windows 2000 or later).

C 67

The C key.

Clear 12

The CLEAR key.

CrSel 247

The CRSEL (CURSOR SELECT) key.

D 68

The D key.

D0 48

The 0 key.

D1 49

The 1 key.

D2 50

The 2 key.

D3 51

The 3 key.

D4 52

The 4 key.

D5 53

The 5 key.

D6 54

The 6 key.

D7 55

The 7 key.

D8 56

The 8 key.

D9 57

The 9 key.

Decimal 110

The Decimal key (the decimal key on the numeric keypad).

Delete 46

The DEL (DELETE) key.

Divide 111

The Divide key (the division key on the numeric keypad).

DownArrow 40

The DOWN ARROW key.

E 69

The E key.

End 35

The END key.

Enter 13

The ENTER key.

EraseEndOfFile 249

The ERASE EOF key.

Escape 27

The ESC (ESCAPE) key.

Execute 43

The EXECUTE key.

ExSel 248

The EXSEL (EXTEND SELECTION) key.

F 70

The F key.

F1 112

The F1 key.

F10 121

The F10 key.

F11 122

The F11 key.

F12 123

The F12 key.

F13 124

The F13 key.

F14 125

The F14 key.

F15 126

The F15 key.

F16 127

The F16 key.

F17 128

The F17 key.

F18 129

The F18 key.

F19 130

The F19 key.

F2 113

The F2 key.

F20 131

The F20 key.

F21 132

The F21 key.

F22 133

The F22 key.

F23 134

The F23 key.

F24 135

The F24 key.

F3 114

The F3 key.

F4 115

The F4 key.

F5 116

The F5 key.

F6 117

The F6 key.

F7 118

The F7 key.

F8 119

The F8 key.

F9 120

The F9 key.

G 71

The G key.

H 72

The H key.

Help 47

The HELP key.

Home 36

The HOME key.

I 73

The I key.

Insert 45

The INS (INSERT) key.

J 74

The J key.

K 75

The K key.

L 76

The L key.

LaunchApp1 182

The Start Application 1 key (Microsoft Natural Keyboard, Windows 2000 or later).

LaunchApp2 183

The Start Application 2 key (Microsoft Natural Keyboard, Windows 2000 or later).

LaunchMail 180

The Start Mail key (Microsoft Natural Keyboard, Windows 2000 or later).

LaunchMediaSelect 181

The Select Media key (Microsoft Natural Keyboard, Windows 2000 or later).

LeftArrow 37

The LEFT ARROW key.

LeftWindows 91

The left Windows logo key (Microsoft Natural Keyboard).

M 77

The M key.

MediaNext 176

The Media Next Track key (Windows 2000 or later).

MediaPlay 179

The Media Play/Pause key (Windows 2000 or later).

MediaPrevious 177

The Media Previous Track key (Windows 2000 or later).

MediaStop 178

The Media Stop key (Windows 2000 or later).

Multiply 106

The Multiply key (the multiplication key on the numeric keypad).

N 78

The N key.

NoName 252

A constant reserved for future use.

NumPad0 96

The 0 key on the numeric keypad.

NumPad1 97

The 1 key on the numeric keypad.

NumPad2 98

The 2 key on the numeric keypad.

NumPad3 99

The 3 key on the numeric keypad.

NumPad4 100

The 4 key on the numeric keypad.

NumPad5 101

The 5 key on the numeric keypad.

NumPad6 102

The 6 key on the numeric keypad.

NumPad7 103

The 7 key on the numeric keypad.

NumPad8 104

The 8 key on the numeric keypad.

NumPad9 105

The 9 key on the numeric keypad.

O 79

The O key.

Oem1 186

The OEM 1 key (OEM specific).

Oem102 226

The OEM 102 key (OEM specific).

Oem2 191

The OEM 2 key (OEM specific).

Oem3 192

The OEM 3 key (OEM specific).

Oem4 219

The OEM 4 key (OEM specific).

Oem5 220

The OEM 5 (OEM specific).

Oem6 221

The OEM 6 key (OEM specific).

Oem7 222

The OEM 7 key (OEM specific).

Oem8 223

The OEM 8 key (OEM specific).

OemClear 254

The CLEAR key (OEM specific).

OemComma 188

The OEM Comma key on any country/region keyboard (Windows 2000 or later).

OemMinus 189

The OEM Minus key on any country/region keyboard (Windows 2000 or later).

OemPeriod 190

The OEM Period key on any country/region keyboard (Windows 2000 or later).

OemPlus 187

The OEM Plus key on any country/region keyboard (Windows 2000 or later).

P 80

The P key.

Pa1 253

The PA1 key.

Packet 231

The PACKET key (used to pass Unicode characters with keystrokes).

PageDown 34

The PAGE DOWN key.

PageUp 33

The PAGE UP key.

Pause 19

The PAUSE key.

Play 250

The PLAY key.

Print 42

The PRINT key.

PrintScreen 44

The PRINT SCREEN key.

Process 229

The IME PROCESS key.

Q 81

The Q key.

R 82

The R key.

RightArrow 39

The RIGHT ARROW key.

RightWindows 92

The right Windows logo key (Microsoft Natural Keyboard).

S 83

The S key.

Select 41

The SELECT key.

Separator 108

The Separator key.

Sleep 95

The Computer Sleep key.

Spacebar 32

The SPACEBAR key.

Subtract 109

The Subtract key (the subtraction key on the numeric keypad).

T 84

The T key.

Tab 9

The TAB key.

U 85

The U key.

UpArrow 38

The UP ARROW key.

V 86

The V key.

VolumeDown 174

The Volume Down key (Microsoft Natural Keyboard, Windows 2000 or later).

VolumeMute 173

The Volume Mute key (Microsoft Natural Keyboard, Windows 2000 or later).

VolumeUp 175

The Volume Up key (Microsoft Natural Keyboard, Windows 2000 or later).

W 87

The W key.

X 88

The X key.

Y 89

The Y key.

Z 90

The Z key.

Zoom 251

The ZOOM key.

Examples

The following example uses the ConsoleKey enumeration to indicate to the user which key the user had pressed.

using namespace System;
using namespace System::Text;

void main()
{
   ConsoleKeyInfo input;
   do {
      Console::WriteLine("Press a key, together with Alt, Ctrl, or Shift.");
      Console::WriteLine("Press Esc to exit.");
      input = Console::ReadKey(true);

      StringBuilder^ output = gcnew StringBuilder(
                     String::Format("You pressed {0}", input.Key.ToString()));
      bool modifiers = false;

      if ((input.Modifiers & ConsoleModifiers::Alt) == ConsoleModifiers::Alt) {
         output->Append(", together with " + ConsoleModifiers::Alt.ToString());
         modifiers = true;
      }
      if ((input.Modifiers & ConsoleModifiers::Control) == ConsoleModifiers::Control)
      {
         if (modifiers) {
            output->Append(" and ");
         }   
         else {
            output->Append(", together with ");
            modifiers = true;
         }
         output->Append(ConsoleModifiers::Control.ToString());
      }
      if ((input.Modifiers & ConsoleModifiers::Shift) == ConsoleModifiers::Shift)
      {
         if (modifiers) {
            output->Append(" and ");
         }   
         else {
            output->Append(", together with ");
            modifiers = true;
         }
         output->Append(ConsoleModifiers::Shift.ToString());
      }
      output->Append(".");                  
      Console::WriteLine(output->ToString());
      Console::WriteLine();
   } while (input.Key != ConsoleKey::Escape);
}
// The output from a sample console session might appear as follows:
//       Press a key, along with Alt, Ctrl, or Shift.
//       Press Esc to exit.
//       You pressed D.
//       
//       Press a key, along with Alt, Ctrl, or Shift.
//       Press Esc to exit.
//       You pressed X, along with Shift.
//       
//       Press a key, along with Alt, Ctrl, or Shift.
//       Press Esc to exit.
//       You pressed L, along with Control and Shift.
//       
//       Press a key, along with Alt, Ctrl, or Shift.
//       Press Esc to exit.
//       You pressed P, along with Alt and Control and Shift.
//       
//       Press a key, along with Alt, Ctrl, or Shift.
//       Press Esc to exit.
//       You pressed Escape. 
using System;
using System.Text;

public class ConsoleKeyExample
{
   public static void Main()
   {
      ConsoleKeyInfo input;
      do {
         Console.WriteLine("Press a key, together with Alt, Ctrl, or Shift.");
         Console.WriteLine("Press Esc to exit.");
         input = Console.ReadKey(true);

         StringBuilder output = new StringBuilder(
                       String.Format("You pressed {0}", input.Key.ToString()));
         bool modifiers = false;
         
         if ((input.Modifiers & ConsoleModifiers.Alt) == ConsoleModifiers.Alt) {
            output.Append(", together with " + ConsoleModifiers.Alt.ToString());
            modifiers = true;
         }
         if ((input.Modifiers & ConsoleModifiers.Control) == ConsoleModifiers.Control)
         {
            if (modifiers) {
               output.Append(" and ");
            }   
            else {
               output.Append(", together with ");
               modifiers = true;
            }
            output.Append(ConsoleModifiers.Control.ToString());
         }
         if ((input.Modifiers & ConsoleModifiers.Shift) == ConsoleModifiers.Shift)
         {
            if (modifiers) {
               output.Append(" and ");
            }   
            else {
               output.Append(", together with ");
               modifiers = true;
            }
            output.Append(ConsoleModifiers.Shift.ToString());
         }
         output.Append(".");                  
         Console.WriteLine(output.ToString());
         Console.WriteLine();
      } while (input.Key != ConsoleKey.Escape);
   }
}
// The output from a sample console session might appear as follows:
//       Press a key, along with Alt, Ctrl, or Shift.
//       Press Esc to exit.
//       You pressed D.
//       
//       Press a key, along with Alt, Ctrl, or Shift.
//       Press Esc to exit.
//       You pressed X, along with Shift.
//       
//       Press a key, along with Alt, Ctrl, or Shift.
//       Press Esc to exit.
//       You pressed L, along with Control and Shift.
//       
//       Press a key, along with Alt, Ctrl, or Shift.
//       Press Esc to exit.
//       You pressed P, along with Alt and Control and Shift.
//       
//       Press a key, along with Alt, Ctrl, or Shift.
//       Press Esc to exit.
//       You pressed Escape. 
Imports System.Text

Module ConsoleKeyExample

   Public Sub Main()
      Dim input As ConsoleKeyInfo
      Do 
         Console.WriteLine("Press a key, together with Alt, Ctrl, or Shift.")
         Console.WriteLine("Press Esc to exit.")
         input = Console.ReadKey(True)

         Dim output As New StringBuilder(String.Format("You pressed {0}", input.Key.ToString()))
         Dim modifiers As Boolean

         If (input.Modifiers And ConsoleModifiers.Alt) = ConsoleModifiers.Alt Then
            output.Append(", together with " + ConsoleModifiers.Alt.ToString())
            modifiers = True
         End If
         If (input.Modifiers And ConsoleModifiers.Control) = ConsoleModifiers.Control Then
            If modifiers Then
               output.Append(" and ")
            Else
               output.Append(", together with ")
               modifiers = True
            End If
            output.Append(ConsoleModifiers.Control.ToString)
         End If
         If (input.Modifiers And ConsoleModifiers.Shift) = ConsoleModifiers.Shift Then
            If modifiers Then
               output.Append(" and ")
            Else
               output.Append(", together with ")
            End If
            output.Append(ConsoleModifiers.Shift.ToString)
         End If
         output.Append(".")                  
         Console.WriteLine(output.ToString())
         Console.WriteLine()
      Loop While input.Key <> ConsoleKey.Escape        
   End Sub
End Module
' The output from a sample console session might appear as follows:
'       Press a key, along with Alt, Ctrl, or Shift.
'       Press Esc to exit.
'       You pressed D.
'       
'       Press a key, along with Alt, Ctrl, or Shift.
'       Press Esc to exit.
'       You pressed X, along with Shift.
'       
'       Press a key, along with Alt, Ctrl, or Shift.
'       Press Esc to exit.
'       You pressed L, along with Control and Shift.
'       
'       Press a key, along with Alt, Ctrl, or Shift.
'       Press Esc to exit.
'       You pressed P, along with Alt and Control and Shift.
'       
'       Press a key, along with Alt, Ctrl, or Shift.
'       Press Esc to exit.
'       You pressed Escape. 

Remarks

The ConsoleKey enumeration is typically used in the nfo structure, which is returned by the Console.ReadKey method to indicate which key on the console has been pressed.

Applies to