Skip to main content

KeyGesture Class

Definition

Namespace:Avalonia.Input
Assembly:Avalonia.Base
Package:Avalonia

Defines a keyboard input combination.

public class KeyGesture

Inheritance: object -> KeyGesture

Implements: IEquatable<KeyGesture>, IFormattable

Constructors

NameDescription
KeyGestureNo summary available.

KeyGesture Constructor

public KeyGesture(Avalonia.Input.Key key, Avalonia.Input.KeyModifiers modifiers)

Parameters

key Avalonia.Input.Key

modifiers Avalonia.Input.KeyModifiers

Methods

NameDescription
Equals (2 overloads)No summary available.
GetHashCodeNo summary available.
MatchesNo summary available.
ParseNo summary available.
ToString (2 overloads)No summary available.

Equals overloads

Equals Method

public bool Equals(Avalonia.Input.KeyGesture other)
Parameters

other Avalonia.Input.KeyGesture

Returns

bool

Equals Method

public bool Equals(object obj)
Parameters

obj object

Returns

bool

GetHashCode Method

public int GetHashCode()

Returns

int

Matches Method

public bool Matches(Avalonia.Input.KeyEventArgs keyEvent)

Parameters

keyEvent Avalonia.Input.KeyEventArgs

Returns

bool

Parse Method

public Avalonia.Input.KeyGesture Parse(string gesture)

Parameters

gesture string

Returns

Avalonia.Input.KeyGesture

ToString overloads

ToString Method

public string ToString()
Returns

string

ToString Method

Returns the current KeyGesture as a string formatted according to the format string and appropriate IFormatProvider

public string ToString(string format, IFormatProvider formatProvider)
Parameters

format string

The format to use.

  • null or "" or "g"The Invariant format, uses Enum.ToString() to format Keys.
  • "p"Use platform specific formatting as registerd.

formatProvider IFormatProvider

The IFormatProvider to use. If null, uses the appropriate provider registered in the Avalonia Locator, or Invariant.

Returns

string

The formatted string.

Exceptions

Properties

NameDescription
KeyNo summary available.
KeyModifiersNo summary available.

Key Property

public Avalonia.Input.Key Key { get; set; }

KeyModifiers Property

public Avalonia.Input.KeyModifiers KeyModifiers { get; set; }