H.Hooks 1.4.21

There is a newer version of this package available.
See the version list below for details.
dotnet add package H.Hooks --version 1.4.21
NuGet\Install-Package H.Hooks -Version 1.4.21
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="H.Hooks" Version="1.4.21" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add H.Hooks --version 1.4.21
#r "nuget: H.Hooks, 1.4.21"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install H.Hooks as a Cake Addin
#addin nuget:?package=H.Hooks&version=1.4.21

// Install H.Hooks as a Cake Tool
#tool nuget:?package=H.Hooks&version=1.4.21

H.Hooks

Language License Requirements Build Status

It uses Win32 kernel32.dll and user32.dll calls inside. Contains LowLevelKeyboardHook and LowLevelMouseHook.

Features:

  • Global key handling and cancellation
  • Allows handling combination like 1 + 2 + 3
  • Only one Up event per combination
  • Handle special buttons like Mouse.XButton
  • Optimized, runs hooks in a separate thread. Does not cause freezes when debugging the rest of the code.
  • By default, it delivers events from a ThreadPool instead of a hook thread, which makes it possible to do any action in event handlers without affecting system performance.

Nuget

NuGet

Install-Package H.Hooks

Usage

using var keyboardHook = new LowLevelKeyboardHook();
keyboardHook.Up += (_, args) => Console.WriteLine($"{nameof(keyboardHook.Up)}: {args}");
keyboardHook.Down += (_, args) => Console.WriteLine($"{nameof(keyboardHook.Down)}: {args}");

keyboardHook.Start();

using var mouseHook = new LowLevelMouseHook();
mouseHook.Down += (_, args) => Console.WriteLine($"{nameof(mouseHook.Down)}: {args}");
mouseHook.Move += (_, args) => Console.WriteLine($"{nameof(mouseHook.Move)}: {args}");

mouseHook.Start();

// Check keys
if (args.Keys.Are(Key.Control, Key.Escape)) {
    // Exit?
}

Interception of input and cancellation

Allows you to intercept input for other applications and cancel events (via args.IsHandled = true).
Do not enable this unless you need it.
When enabled, overrides the automatic dispatch of events to the ThreadPool and may cause performance issues with any slow handlers. In this case, you need to use ThreadPool.QueueUserWorkItem(WaitCallback) when handling events (after set up args.IsHandled = true).

hook.Handling = true;
hook.Up += (_, args) => args.IsHandled = true;

Advanced usage

// Enables Move events.
mouseHook.GenerateMouseMoveEvents = true;

// Adds keyboard keys. Allows getting combinations like Shift + LeftMouse.
mouseHook.AddKeyboardKeys = true;

// Sends multiple events while key pressed.
keyboardHook.OneUpEvent = false;

// Allows handle modifier keys.
keyboardHook.HandleModifierKeys = true;

// Allows common key combinations, like 1 + 2 + 3.
hook.IsExtendedMode = true;

// Events will contains separate Left/Right keys.
hook.IsLeftRightGranularity = true;

// Uses User32.GetKeyboardState instead User32.GetKeyState.
// Disable this if any problem.
hook.UseKeyboardState = false;

// Adds Key.Caps to each event if CapsLock is toggled.
hook.IsCapsLock = false;

Contacts

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net451 is compatible.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on H.Hooks:

Package Downloads
H.Services.HookService

Allows you to bind commands to system-wide hotkeys.

H.Runners.SelectRunner

Allows you to select a portion of the screen.

Frank.Libraries.Machine

Not very useful at the moment, but is intended to become a helpful tool for accessing device information

Responsive

Package Description

ResponsiveForm

Package Description

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on H.Hooks:

Repository Stars
rocksdanister/lively
Free and open-source software that allows users to set animated desktop wallpapers and screensavers powered by WinUI 3.
w4po/ExplorerTabUtility
Explorer Tab Utility: Force new windows to tabs. Streamline navigation!
Version Downloads Last updated
1.6.0 9,359 8/1/2022
1.4.21 1,102 4/1/2022
1.4.20 1,614 3/27/2022
1.4.19 499 3/17/2022
1.4.18 705 2/15/2022
1.4.17 433 2/15/2022
1.4.14 1,173 10/23/2021
1.4.13 390 10/21/2021
1.4.12 340 10/21/2021
1.4.9 1,291 7/9/2021
1.4.8 410 7/9/2021
1.4.7 369 7/8/2021
1.4.6 533 6/14/2021
1.4.5 439 6/13/2021
1.4.3 352 6/13/2021
1.3.2 2,279 1/22/2021
1.3.1 543 1/21/2021
1.3.0 408 1/21/2021
1.2.4 410 1/21/2021
1.2.3 984 1/20/2021
1.2.2 2,457 1/19/2021
1.2.1 1,764 1/18/2021
1.2.0 346 1/16/2021
1.1.0 377 1/15/2021
1.0.1 8,884 12/15/2020
1.0.0 410 12/15/2020

⭐ Last 10 features:
- feat: To CsWin32. 2022-03-27
- feat: Added KeyboardEventArgs.CurrentKey property. 2022-03-17
- feat: Added net5/net6 targets. 2022-03-17
- fix: Fixed preview features. 2022-02-15
- feat: Added Keys.Are method. 2022-02-15
- feat: Changed minimal requirement to net4.5.1. 2022-02-15
- feat: Updated README. 2021-10-21
- feat: to net6.0 and C# 10. 2021-10-21
- feat: Updated package description. 2021-06-14
- feat: Added auto-releasing. 2021-06-13

🐞 Last 10 bug fixes:
- fix: Fixed PInvoke error check. 2022-04-01
- fix: Fixed #2 issue. 2022-02-15
- fix: Fixed preview features. 2022-02-15
- fix: Added Keys == and != operators. 2022-02-15
- fix: Fixed ci os. 2021-10-21
- fix: Fixed PackageReadmeFile. 2021-10-21
- fix: Fixed ConsoleApp. 2021-10-21
- fix: Deleted unused code. 2021-07-10
- fix: Fixed PackageReadmeFile bug. 2021-06-13
- fix: Fixed mouse double click bug. 2021-01-22