ConsoleKeyInfo Structure
Assembly: mscorlib (in mscorlib.dll)
The ConsoleKeyInfo type is not intended to be created by users. Instead, it is returned to the user in response to calling the Console.ReadKey method.
The ConsoleKeyInfo object describes the ConsoleKey constant and Unicode character, if any, that correspond to the pressed console key. The ConsoleKeyInfo object also describes, in a bitwise combination of ConsoleModifiers values, whether one or more SHIFT, ALT, or CTRL modifier keys was pressed simultaneously with the console key.
The following code example demonstrates using a ConsoleKeyInfo object in a read operation.
// This example demonstrates the Console.ReadKey() method using System; using System.Text; class Sample { public static void Main() { ConsoleKeyInfo cki; // 0 1 2 3 4 5 6 // 123456789012345678901234567890123456879012345678901234567890 String m1 = "This example discovers the console and modifier keys " + "that you press.\n"; String m2 = "Press any combination of CTL, ALT, and SHIFT modifier keys, " + "and a console key.\nPress the Escape (Esc) key to quit: "; String m3 = "You pressed "; String m4 = " (character '{0}')."; StringBuilder sb = new StringBuilder(); // // The Console.TreatControlCAsInput property prevents this example from // ending if you press CTL+C, however all other operating system keys and // shortcuts, such as ALT+TAB or the Windows Logo key, are still in effect. // Console.TreatControlCAsInput = true; Console.WriteLine(m1); do { Console.WriteLine(m2); sb.Length = 0; cki = Console.ReadKey(true); sb.Append(m3); if (cki.Modifiers != 0) { if ((cki.Modifiers & ConsoleModifiers.Alt) != 0) sb.Append("ALT+"); if ((cki.Modifiers & ConsoleModifiers.Shift) != 0) sb.Append("SHIFT+"); if ((cki.Modifiers & ConsoleModifiers.Control) != 0) sb.Append("CTL+"); } sb.Append(cki.Key.ToString()); sb.AppendFormat(m4, cki.KeyChar); sb.AppendLine().AppendLine(); Console.WriteLine(sb.ToString()); } while (cki.Key != ConsoleKey.Escape); // Note: This example requires the Escape (Esc) key. } } /* This example produces results similar to following text: This example discovers the console and modifier keys that you press. Press any combination of CTL, ALT, and SHIFT modifier keys, and a console key. Press the Escape (Esc) key to quit: You pressed A (character 'a'). Press any combination of CTL, ALT, and SHIFT modifier keys, and a console key. Press the Escape (Esc) key to quit: You pressed SHIFT+A (character 'A'). Press any combination of CTL, ALT, and SHIFT modifier keys, and a console key. Press the Escape (Esc) key to quit: You pressed ALT+SHIFT+CTL+A (character ' '). Press any combination of CTL, ALT, and SHIFT modifier keys, and a console key. Press the Escape (Esc) key to quit: You pressed Escape (character '?'). */
// This example demonstrates the Console.ReadKey() method
import System.*;
import System.Text.*;
class Sample
{
public static void main(String[] args)
{
ConsoleKeyInfo cki;
// 0 1 2 3 4 5 6
// 123456789012345678901234567890123456879012345678901234567890
String m1 = "This example discovers the console and modifier keys "
+ "that you press.\n";
String m2 = "Press any combination of CTL, ALT, and SHIFT modifier keys, "
+ "and a console key.\nPress the Escape (Esc) key to quit: ";
String m3 = "You pressed ";
String m4 = " (character '{0}').";
StringBuilder sb = new StringBuilder();
//
// The Console.TreatControlCAsInput property prevents this example from
// ending if you press CTL+C, however all other operating system keys and
// shortcuts, such as ALT+TAB or the Windows Logo key, are still in
// effect.
//
Console.set_TreatControlCAsInput(true);
Console.WriteLine(m1);
do {
Console.WriteLine(m2);
sb.set_Length(0);
cki = Console.ReadKey(true);
sb.Append(m3);
if (!(cki.get_Modifiers().Equals((Int32)0))) {
if (!((cki.get_Modifiers() & ConsoleModifiers.Alt).ToString().
Equals(Convert.ToString(0)))) {
sb.Append("ALT+");
}
if (!((cki.get_Modifiers() & ConsoleModifiers.Shift).ToString().
Equals(Convert.ToString(0)))) {
sb.Append("SHIFT+");
}
if (!((cki.get_Modifiers() & ConsoleModifiers.Control).ToString().
Equals(Convert.ToString(0)))) {
sb.Append("CTL+");
}
}
sb.Append(cki.get_Key().ToString());
sb.AppendFormat(m4, (System.Char)cki.get_KeyChar());
sb.AppendLine().AppendLine();
Console.WriteLine(sb.ToString());
} while (!(cki.get_Key().Equals(ConsoleKey.Escape)));
// Note: This example requires the Escape (Esc) key.
} //main
} //Sample
/*
This example produces results similar to following text:
This example discovers the console and modifier keys that you press.
Press any combination of CTL, ALT, and SHIFT modifier keys, and a console key.
Press the Escape (Esc) key to quit:
You pressed A (character 'a').
Press any combination of CTL, ALT, and SHIFT modifier keys, and a console key.
Press the Escape (Esc) key to quit:
You pressed SHIFT+A (character 'A').
Press any combination of CTL, ALT, and SHIFT modifier keys, and a console key.
Press the Escape (Esc) key to quit:
You pressed ALT+SHIFT+CTL+A (character ' ').
Press any combination of CTL, ALT, and SHIFT modifier keys, and a console key.
Press the Escape (Esc) key to quit:
You pressed Escape (character '?').
*/
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.