Class ConsoleKeyMapping

Helper class to handle the scan code and virtual key from a ConsoleKey.

Inheritance

object

ConsoleKeyMapping

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Terminal.Gui

Assembly: Terminal.Gui.dll

Syntax

public static class ConsoleKeyMapping

Methods

GetConsoleKeyFromKey(uint, ConsoleModifiers, out uint, out uint)

Get the ConsoleKey from a Key.

Declaration

public static uint GetConsoleKeyFromKey(uint keyValue, ConsoleModifiers modifiers, out uint scanCode, out uint outputChar)

Parameters

Type	Name	Description
uint	keyValue	The key value.
ConsoleModifiers	modifiers	The modifiers keys.
uint	scanCode	The resulting scan code.
uint	outputChar	The resulting output character.

Returns

Type	Description
uint	The ConsoleKey or the outputChar.

GetKeyCharFromConsoleKey(uint, ConsoleModifiers, out uint, out uint)

Get the output character from the ConsoleKey.

Declaration

public static uint GetKeyCharFromConsoleKey(uint unicodeChar, ConsoleModifiers modifiers, out uint consoleKey, out uint scanCode)

Parameters

Type	Name	Description
uint	unicodeChar	The unicode character.
ConsoleModifiers	modifiers	The modifiers keys.
uint	consoleKey	The resulting console key.
uint	scanCode	The resulting scan code.

Returns

Type	Description
uint	The output character or the consoleKey.

MapConsoleKeyToKey(ConsoleKey, out bool)

Maps a ConsoleKey to a Key.

Declaration

public static Key MapConsoleKeyToKey(ConsoleKey consoleKey, out bool isMappable)

Parameters

Type	Name	Description
ConsoleKey	consoleKey	The console key.
bool	isMappable	If true is mapped to a valid character, otherwise false.

Returns

Type	Description
Key	The Key or the consoleKey.

MapKeyModifiers(ConsoleKeyInfo, Key)

Maps a ConsoleKeyInfo to a Key.

Declaration

public static Key MapKeyModifiers(ConsoleKeyInfo keyInfo, Key key)

Parameters

Type	Name	Description
ConsoleKeyInfo	keyInfo	The console key info.
Key	key	The key.

Returns

Type	Description
Key	The Key with ConsoleModifiers or the key

MapKeyToConsoleKey(uint, out bool)

Maps a Key to a ConsoleKey.

Declaration

public static uint MapKeyToConsoleKey(uint keyValue, out bool isMappable)

Parameters

Type	Name	Description
uint	keyValue	The key value.
bool	isMappable	If true is mapped to a valid character, otherwise false.

Returns

Type	Description
uint	The ConsoleKey or the keyValue.