Class GlobalHookBase
- Namespace
- SharpHook
- Assembly
- SharpHook.dll
Represents an abstract implementation of IGlobalHook which defines everything needed except for a strategy for dispatching events and uses a global hook provider (libuiohook by default).
public abstract class GlobalHookBase : IGlobalHook, IDisposable- Inheritance
-
GlobalHookBase
- Implements
- Derived
- Inherited Members
Constructors
GlobalHookBase()
Initializes a new instance of GlobalHookBase.
protected GlobalHookBase()- See Also
GlobalHookBase(IGlobalHookProvider)
Initializes a new instance of GlobalHookBase.
protected GlobalHookBase(IGlobalHookProvider globalHookProvider)Parameters
globalHookProviderIGlobalHookProviderThe underlying global hook provider.
Exceptions
- ArgumentNullException
globalHookProvideris null.
- See Also
GlobalHookBase(IGlobalHookProvider, bool)
Initializes a new instance of GlobalHookBase.
protected GlobalHookBase(IGlobalHookProvider globalHookProvider, bool runAsyncOnBackgroundThread)Parameters
globalHookProviderIGlobalHookProviderThe underlying global hook provider.
runAsyncOnBackgroundThreadbooltrue if RunAsync() should run the hook on a background thread. Otherwise, false.
Exceptions
- ArgumentNullException
globalHookProvideris null.
- See Also
GlobalHookBase(bool)
Initializes a new instance of GlobalHookBase.
protected GlobalHookBase(bool runAsyncOnBackgroundThread)Parameters
runAsyncOnBackgroundThreadbooltrue if RunAsync() should run the hook on a background thread. Otherwise, false.
- See Also
Properties
IsDisposed
Gets the value which indicates whether the global hook is disposed.
public bool IsDisposed { get; }Property Value
Remarks
A disposed global hook cannot be started again.
- See Also
IsRunning
Gets the value which indicates whether the global hook is running.
public bool IsRunning { get; }Property Value
- See Also
Methods
DispatchEvent(ref UioHookEvent)
Dispatches an event from libuiohook, i.e. raises the appropriate event.
protected void DispatchEvent(ref UioHookEvent e)Parameters
eUioHookEventThe event to dispatch.
- See Also
Dispose()
Destroys the global hook.
public void Dispose()Remarks
After calling this method, the hook cannot be started again. If you want to do that, create a new instance of IGlobalHook.
Exceptions
- HookException
Stopping the hook has failed.
- See Also
Dispose(bool)
Destoys the global hook.
protected virtual void Dispose(bool disposing)Parameters
Exceptions
- HookException
Stopping the hook has failed.
- See Also
~GlobalHookBase()
Destroys the global hook if it's running.
protected ~GlobalHookBase()- See Also
HandleHookEvent(ref UioHookEvent)
When implemented in a derived class, represents a strategy for handling a hook event.
protected abstract void HandleHookEvent(ref UioHookEvent e)Parameters
eUioHookEventThe event to handle.
Remarks
Derived classes should call DispatchEvent(ref UioHookEvent) inside this method to raise the appropriate event.
- See Also
OnHookDisabled(HookEventArgs)
Raises the HookDisabled event with this object as the sender.
protected virtual void OnHookDisabled(HookEventArgs args)Parameters
argsHookEventArgsThe arguments of the event.
- See Also
OnHookEnabled(HookEventArgs)
Raises the HookEnabled event with this object as the sender.
protected virtual void OnHookEnabled(HookEventArgs args)Parameters
argsHookEventArgsThe arguments of the event.
- See Also
OnKeyPressed(KeyboardHookEventArgs)
Raises the KeyPressed event with this object as the sender.
protected virtual void OnKeyPressed(KeyboardHookEventArgs args)Parameters
argsKeyboardHookEventArgsThe arguments of the event.
- See Also
OnKeyReleased(KeyboardHookEventArgs)
Raises the KeyReleased event with this object as the sender.
protected virtual void OnKeyReleased(KeyboardHookEventArgs args)Parameters
argsKeyboardHookEventArgsThe arguments of the event.
- See Also
OnKeyTyped(KeyboardHookEventArgs)
Raises the KeyTyped event with this object as the sender.
protected virtual void OnKeyTyped(KeyboardHookEventArgs args)Parameters
argsKeyboardHookEventArgsThe arguments of the event.
- See Also
OnMouseClicked(MouseHookEventArgs)
Raises the MouseClicked event with this object as the sender.
protected virtual void OnMouseClicked(MouseHookEventArgs args)Parameters
argsMouseHookEventArgsThe arguments of the event.
- See Also
OnMouseDragged(MouseHookEventArgs)
Raises the MouseDragged event with this object as the sender.
protected virtual void OnMouseDragged(MouseHookEventArgs args)Parameters
argsMouseHookEventArgsThe arguments of the event.
- See Also
OnMouseMoved(MouseHookEventArgs)
Raises the MouseMoved event with this object as the sender.
protected virtual void OnMouseMoved(MouseHookEventArgs args)Parameters
argsMouseHookEventArgsThe arguments of the event.
- See Also
OnMousePressed(MouseHookEventArgs)
Raises the MousePressed event with this object as the sender.
protected virtual void OnMousePressed(MouseHookEventArgs args)Parameters
argsMouseHookEventArgsThe arguments of the event.
- See Also
OnMouseReleased(MouseHookEventArgs)
Raises the MouseReleased event with this object as the sender.
protected virtual void OnMouseReleased(MouseHookEventArgs args)Parameters
argsMouseHookEventArgsThe arguments of the event.
- See Also
OnMouseWheel(MouseWheelHookEventArgs)
Raises the MouseWheel event with this object as the sender.
protected virtual void OnMouseWheel(MouseWheelHookEventArgs args)Parameters
argsMouseWheelHookEventArgsThe arguments of the event.
- See Also
Run()
Runs the global hook on the current thread, blocking it. The hook can be destroyed by calling the Dispose() method.
public void Run()Exceptions
- HookException
Starting the global hook has failed.
- InvalidOperationException
The global hook is already running.
- ObjectDisposedException
The global hook has been disposed.
- See Also
RunAsync()
Runs the global hook without blocking the current thread. The hook can be destroyed by calling the Dispose() method.
public Task RunAsync()Returns
Remarks
The hook is started on a separate thread.
Exceptions
- HookException
Starting the global hook has failed.
- InvalidOperationException
The global hook is already running.
- ObjectDisposedException
The global hook has been disposed.
- See Also
ThrowIfDisposed(string?)
Throws an ObjectDisposedException if this object is disposed.
protected void ThrowIfDisposed(string? method = null)Parameters
methodstringThe method which calls this method.
- See Also
Events
HookDisabled
An event which is raised when the global hook is disabled.
public event EventHandler<HookEventArgs>? HookDisabledEvent Type
Remarks
This event is raised when the Dispose() method is called.
- See Also
HookEnabled
An event which is raised when the global hook is enabled.
public event EventHandler<HookEventArgs>? HookEnabledEvent Type
Remarks
This event is raised when the Run() or RunAsync() method is called.
- See Also
KeyPressed
An event which is raised when a key is pressed.
public event EventHandler<KeyboardHookEventArgs>? KeyPressedEvent Type
- See Also
KeyReleased
An event which is raised when a key is released.
public event EventHandler<KeyboardHookEventArgs>? KeyReleasedEvent Type
- See Also
KeyTyped
An event which is raised when a key is typed.
public event EventHandler<KeyboardHookEventArgs>? KeyTypedEvent Type
- See Also
MouseClicked
An event which is raised when a mouse button is clicked.
public event EventHandler<MouseHookEventArgs>? MouseClickedEvent Type
- See Also
MouseDragged
An event which is raised when the mouse cursor is dragged.
public event EventHandler<MouseHookEventArgs>? MouseDraggedEvent Type
- See Also
MouseMoved
An event which is raised when the mouse cursor is moved.
public event EventHandler<MouseHookEventArgs>? MouseMovedEvent Type
- See Also
MousePressed
An event which is raised when a mouse button is pressed.
public event EventHandler<MouseHookEventArgs>? MousePressedEvent Type
- See Also
MouseReleased
An event which is raised when a mouse button is released.
public event EventHandler<MouseHookEventArgs>? MouseReleasedEvent Type
- See Also
MouseWheel
An event which is raised when the mouse wheel is turned.
public event EventHandler<MouseWheelHookEventArgs>? MouseWheelEvent Type
- See Also