Class HookEventArgs

Namespace

SharpHook

Assembly

SharpHook.dll

A base class for event args related to the global hook.

public class HookEventArgs : EventArgs

Inheritance

object

EventArgs

HookEventArgs

Derived

KeyboardHookEventArgs

MouseHookEventArgs

MouseWheelHookEventArgs

Inherited Members

EventArgs.Empty

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

HookEventArgs(UioHookEvent)

A base class for event args related to the global hook.

public HookEventArgs(UioHookEvent rawEvent)

Parameters

rawEvent UioHookEvent

The raw event data.

See Also

KeyboardHookEventArgs

MouseHookEventArgs

MouseWheelEventData

UioHookEvent

Properties

EventTime

Gets the date and time of the event (in UTC), derived from the event's UNIX timestamp.

public DateTimeOffset EventTime { get; }

Property Value

DateTimeOffset

The date and time of the event.

IsEventSimulated

Gets the value which indicates whether the event has been simulated.

public bool IsEventSimulated { get; }

Property Value

bool

true is the event has been simulated. Otherwise, false.

RawEvent

Gets the raw event data.

public UioHookEvent RawEvent { get; }

Property Value

UioHookEvent

The raw event data.

SuppressEvent

Gets or sets whether to suppress the event from further propagation after running the event handler. Events must be suppressed synchronously. Suppressing events works only on Windows and macOS.

public bool SuppressEvent { get; set; }

Property Value

bool

true if the event propagation should be suppressed. Otherwise, false.

Methods

FromEvent(UioHookEvent)

Creates a new instance of the HookEventArgs class or a derived class, depending on the event type.

public static HookEventArgs FromEvent(UioHookEvent rawEvent)

Parameters

rawEvent UioHookEvent

The raw event data.

Returns

HookEventArgs

See Also

KeyboardHookEventArgs

MouseHookEventArgs

MouseWheelEventData

UioHookEvent