tolik-pylypchuk/SharpHookv1.0.1
.NET FW4.7.2.NET 8.0.NET 9.0.NET 9.0-maccatalyst18.0
SharpHook provides a cross-platform global keyboard and mouse hook, event simulation, and text entry simulation for .NET.
Get Started
$ dotnet add package SharpHookReadme
SharpHook
SharpHook is a library which provides a cross-platform global keyboard and mouse hook for .NET. It is a thin wrapper of libuiohook and provides direct access to its features as well as higher-level types to work with it.
Usage
Native Methods of libuiohook
SharpHook exposes the methods of libuiohook in the SharpHook.Native.UioHook class. The SharpHook.Native
namespace also contains structs and enums which represent the data returned by libuiohook.
Note: In general, you shouldn't use native methods directly. Instead, use the higher-level types provided by SharpHook.
UioHook contains the following methods for working with the global hook:
SetDispatchProc- sets the function which will be called when an event is raised by libuiohook.Run- creates a global hook and runs it on the current thread, blocking it untilStopis called.Stop- destroys the global hook.
libuiohook also provides functions to get various system properties. The corresponding methods are also present in
UioHook.
Default Global Hooks
SharpHook provides the IGlobalHook interface along with two default implementations which you can use to control the
hook and subscribe to its events. Here's a basic usage example:
using SharpHook;
// ...
var hook = new TaskPoolGlobalHook();
hook.HookEnabled += OnHookEnabled;
hook.HookDisabled += OnHookDisabled;
hook.KeyTyped += OnKeyTyped;
hook.KeyPressed += OnKeyPressed;
hook.KeyReleased += OnKeyReleased;
hook.MouseClicked += OnMouseClicked;
hook.MousePressed += OnMousePressed;
hook.MouseReleased += OnMouseReleased;
hook.MouseMoved += OnMouseMoved;
hook.MouseDragged += OnMouseDragged;
hook.MouseWheel += OnMouseWheel;
await hook.Start();
First, you create the hook, then subscribe to its events, and then start it. The Start() method returns a
which is finished when the hook is destroyed, so if you it, you block the current async context until it stops.
You can subscribe to events after the hook is started.