Show / Hide Table of Contents

Struct AsciiKey.CharacterKeyMapping

Associates a character glyph and a Keys value.

Implements
IEquatable<AsciiKey.CharacterKeyMapping>
Inherited Members
object.GetType()
object.Equals(object, object)
object.ReferenceEquals(object, object)
Namespace: SadConsole.Input
Assembly: SadConsole.dll
Syntax
public readonly struct AsciiKey.CharacterKeyMapping : IEquatable<AsciiKey.CharacterKeyMapping>
Remarks

Used when the NumLock is active.

Constructors

CharacterKeyMapping(char, Keys)

Associates a character glyph and a Keys value.

Declaration
public CharacterKeyMapping(char CharacterGlyph, Keys Key)
Parameters
Type Name Description
char CharacterGlyph

The number pad character.

Keys Key

The key the character maps to.

Remarks

Used when the NumLock is active.

Properties

CharacterGlyph

The number pad character.

Declaration
public char CharacterGlyph { get; init; }
Property Value
Type Description
char

Key

The key the character maps to.

Declaration
public Keys Key { get; init; }
Property Value
Type Description
Keys

Methods

Deconstruct(out char, out Keys)

Declaration
public void Deconstruct(out char CharacterGlyph, out Keys Key)
Parameters
Type Name Description
char CharacterGlyph
Keys Key

Equals(CharacterKeyMapping)

Declaration
public bool Equals(AsciiKey.CharacterKeyMapping other)
Parameters
Type Name Description
AsciiKey.CharacterKeyMapping other
Returns
Type Description
bool

Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides
ValueType.Equals(object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides
ValueType.GetHashCode()

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
ValueType.ToString()

Operators

operator ==(CharacterKeyMapping, CharacterKeyMapping)

Declaration
public static bool operator ==(AsciiKey.CharacterKeyMapping left, AsciiKey.CharacterKeyMapping right)
Parameters
Type Name Description
AsciiKey.CharacterKeyMapping left
AsciiKey.CharacterKeyMapping right
Returns
Type Description
bool

operator !=(CharacterKeyMapping, CharacterKeyMapping)

Declaration
public static bool operator !=(AsciiKey.CharacterKeyMapping left, AsciiKey.CharacterKeyMapping right)
Parameters
Type Name Description
AsciiKey.CharacterKeyMapping left
AsciiKey.CharacterKeyMapping right
Returns
Type Description
bool

Implements

IEquatable<T>
In this article

Back to top

Back to top Generated by DocFX