Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bracozs/globalhotkeysrx
Simple C# WPF Library for creating global hotkeys.
https://github.com/bracozs/globalhotkeysrx
csharp desktop global hotkeys net8 windowless windows wpf
Last synced: 4 months ago
JSON representation
Simple C# WPF Library for creating global hotkeys.
- Host: GitHub
- URL: https://github.com/bracozs/globalhotkeysrx
- Owner: BracoZS
- License: mit
- Created: 2024-07-27T03:34:52.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-10T03:32:03.000Z (4 months ago)
- Last Synced: 2024-10-10T14:04:30.082Z (4 months ago)
- Topics: csharp, desktop, global, hotkeys, net8, windowless, windows, wpf
- Language: C#
- Homepage:
- Size: 396 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# GlobalHotKeysRX
A small C# WPF library to create global keyboard shortcuts. With this library, you can implement keyboard shortcuts to perform specific actions in your applications, regardless of the active window.
Works globally, allowing the activation of shortcuts on any window.
*No Window is required, so you can use it in background/windowless applications.
Supports combinations of:
-Modifier keys: Alt, Control, Shift, Win (Up to 3 at the same time)
-WPF Keys, listed at [System.Windows.Input Key Enum](https://learn.microsoft.com/en-us/dotnet/api/system.windows.input.key?view=windowsdesktop-8.0).
[NuGet](https://www.nuget.org/packages/GlobalHotkeysRX) package.
[](https://www.nuget.org/packages/GlobalHotkeysRX/)
-
## Usage
import
```
using GlobalHotKeysRX;
```
initialization
```
Combo combo1 = new Combo(Modifiers.Alt, Key.C); //dual combo (Alt + C)
Combo combo2 = new Combo(Modifiers.Alt | Modifiers.Control, Key.Z); //triple combo (Alt + Control + Z)
HotKeys hks = new HotKeys();
```
> Use the | operator to combine/add modifiers.
>
> By using 'Modifiers.NoRepeat' with another modifier, the application will only receive another WM_HOTKEY message when the key is released and then pressed again while a modifier is held down.
adding a hotkey
```
hks.AddMethod(combo1, myfunction);
void myfunction()
{
//code when hotkey occurs...
}
```
removing
```
hks.DeleteMethod(combo1); //single
```
```
hks.ClearAll(); //all
```
cleaning up resources
```
hks.Dispose();
```
pause/play
```
hks.Pause(combo1); //'Action' is not called
//...
hks.Play(combo1); //'Action' is called again
```
simplest way
```
HotKeys hks = new HotKeys(new Combo(Modifiers.Control, Key.Q), () => { /*code...*/ });
```
### Known issues
This library uses Win32 API. Typically, [RegisterHotKey](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-registerhotkey) fails if the keystrokes specified for the hot key have already been registered for another hot key. However, some pre-existing, default hotkeys registered by the OS (such as PrintScreen, which launches the Snipping tool) may be overridden by another hot key registration when one of the app's windows is in the foreground.
[](https://www.patreon.com/Braco_ZS)
[](https://ko-fi.com/A0A4G6LKI)