ConsoleKeyInfo(Char, ConsoleKey, Boolean, Boolean, Boolean) Constructor

Reference

Definition

Namespace:: System

Assembly:: System.Console.dll

Assembly:: mscorlib.dll

Assembly:: netstandard.dll

Source:: ConsoleKeyInfo.cs

Source:: ConsoleKeyInfo.cs

Source:: ConsoleKeyInfo.cs

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.

Initializes a new instance of the ConsoleKeyInfo structure using the specified character, console key, and modifier keys.

public:
 ConsoleKeyInfo(char keyChar, ConsoleKey key, bool shift, bool alt, bool control);

public ConsoleKeyInfo (char keyChar, ConsoleKey key, bool shift, bool alt, bool control);

new ConsoleKeyInfo : char * ConsoleKey * bool * bool * bool -> ConsoleKeyInfo

Public Sub New (keyChar As Char, key As ConsoleKey, shift As Boolean, alt As Boolean, control As Boolean)

Parameters

keyChar: Char

The Unicode character that corresponds to the key parameter.

key: ConsoleKey

The console key that corresponds to the keyChar parameter.

shift: Boolean

true to indicate that a SHIFT key was pressed; otherwise, false.

alt: Boolean

true to indicate that an ALT key was pressed; otherwise, false.

control: Boolean

true to indicate that a CTRL key was pressed; otherwise, false.

Exceptions

ArgumentOutOfRangeException

The numeric value of the key parameter is less than 0 or greater than 255.

Remarks

This 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 type does not specify whether the left or right SHIFT, ALT, or CTRL modifier key was pressed.

Applies to