Documentation

Version:

Version:

KeyboardEventBase<T>

This is the base class for keyboard events.

Read time 3 minutes

Last updated 2 days ago


public abstract class KeyboardEventBase<T> : EventBase<T>, IDisposable, IKeyboardEvent where T : KeyboardEventBase<T>, new()

The typical keyboard event loop is as follows:

When a key is pressed, a KeyDownEvent is sent.
If the key is held down for a duration determined by the OS, another KeyDownEvent with the same data is sent. While the key is held down, the event is sent repeatedly at a frequency determined by the OS.
When the key is released, a KeyUpEvent is sent.

By default, keyboard events trickle down and bubble up. disabled elements won't receive these events.

Property	Description
actionKey	Gets a boolean value that indicates whether the platform-specific action key is pressed. True means the action key is pressed. False means it isn't.
altKey	Gets a boolean value that indicates whether the Alt key is pressed. True means the Alt key is pressed. False means it isn't.
character	Gets the character entered.
commandKey	Gets a boolean value that indicates whether the Windows/Cmd key is pressed. True means the Windows/Cmd key is pressed. False means it isn't.
ctrlKey	Gets a boolean value that indicates whether the Ctrl key is pressed. True means the Ctrl key is pressed. False means it isn't.
keyCode	The key code.
modifiers	Gets flags that indicate whether modifier keys (Alt, Ctrl, Shift, Windows/Cmd) are pressed.
shiftKey	Gets a boolean value that indicates whether the Shift key is pressed. True means the Shift key is pressed. False means it isn't.

Method	Description
Init	Resets the event members to their initial values.

Method	Description
GetPooled	Gets a keyboard event from the event pool and initializes it with the given values. Use this function instead of creating new events. Events obtained using this method need to be released back to the pool. You can use `Dispose()` to release them.