AspireTerminalKey Methods
StructMethods9 members
Represents one terminal keypress, optionally combined with modifiers, for
AspireTerminal.SendKeyAsync . Adds the Alt modifier to a terminal keypress.
public struct AspireTerminalKey{ public static AspireTerminalKey Alt( AspireTerminalKey key) { // ... }}Parameters
keyAspireReturns
AspireTerminalKey A keypress with Alt added, preserving its key identity and other modifiers.Exceptions
ArgumentExceptionkey is default-initialized.Remarks
Repeated application has no additional effect, and composition with other modifiers is order-independent.
Adds the Control modifier to a terminal keypress.
public struct AspireTerminalKey{ public static AspireTerminalKey Ctrl( AspireTerminalKey key) { // ... }}Parameters
keyAspireReturns
AspireTerminalKey A keypress with Control added, preserving its key identity and other modifiers.Exceptions
ArgumentExceptionkey is default-initialized.Remarks
Repeated application has no additional effect, and composition with other modifiers is order-independent.
Determines whether another keypress has the same key identity and modifiers.
public struct AspireTerminalKey{ public bool Equals( AspireTerminalKey other) { // ... }}Parameters
otherAspireReturns
booltrue if the key identities and modifiers are equal; otherwise, false. Determines whether an object is a keypress with the same key identity and modifiers.
public struct AspireTerminalKey{ public override bool Equals( object? obj) { // ... }}Parameters
objobject?The object to compare, or null.Returns
booltrue if the object is an equal keypress; otherwise, false. Gets a hash code based on the key identity and modifiers.
public struct AspireTerminalKey{ public override int GetHashCode() { // ... }}Returns
intThe hash code for this keypress.op_Equality(AspireTerminalKey, AspireTerminalKey) Section titled op_Equality(AspireTerminalKey, AspireTerminalKey)staticbool Determines whether two keypresses have the same key identity and modifiers.
public struct AspireTerminalKey{ public static bool operator ==( AspireTerminalKey left, AspireTerminalKey right) { // ... }}Parameters
leftAspirerightAspireReturns
booltrue if the keypresses are equal; otherwise, false.op_Inequality(AspireTerminalKey, AspireTerminalKey) Section titled op_Inequality(AspireTerminalKey, AspireTerminalKey)staticbool Determines whether two keypresses differ in key identity or modifiers.
public struct AspireTerminalKey{ public static bool operator !=( AspireTerminalKey left, AspireTerminalKey right) { // ... }}Parameters
leftAspirerightAspireReturns
booltrue if the keypresses differ; otherwise, false. Adds the Shift modifier to a terminal keypress.
public struct AspireTerminalKey{ public static AspireTerminalKey Shift( AspireTerminalKey key) { // ... }}Parameters
keyAspireReturns
AspireTerminalKey A keypress with Shift added, preserving its key identity and other modifiers.Exceptions
ArgumentExceptionkey is default-initialized.Remarks
Repeated application has no additional effect, and composition with other modifiers is order-independent.
Gets a readable description of this keypress.
public struct AspireTerminalKey{ public override string ToString() { // ... }}Returns
string The named key prefixed by any modifiers in Ctrl, Alt, Shift order, separated by +, or Uninitialized for a default-initialized value. 
Aspire