Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

IInputElement Interface

Namespace:
ActiproSoftware.UI.WinForms.Controls
Assembly:
ActiproSoftware.Shared.WinForms.dll

Represents a base requirements for an element that can receive input.

public interface IInputElement

Properties

IsMouseCaptured

Gets whether the element is currently capturing the mouse.

bool IsMouseCaptured { get; }

Property Value

bool:

true if the element is currently capturing the mouse; otherwise, false.

IsMouseDirectlyOver

Gets whether the mouse is directly over the element.

bool IsMouseDirectlyOver { get; }

Property Value

bool:

true if the mouse is directly over the element; otherwise, false.

Methods

CaptureMouse()

Attaches the mouse capture to the component.

void CaptureMouse()

RaiseClickEvent(MouseEventArgs)

Generates a Click event for the object.

void RaiseClickEvent(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

A MouseEventArgs that contains the event data.

Remarks

This method can be called to raise the Click event.

RaiseDoubleClickEvent(MouseEventArgs)

Generates a DoubleClick event for the object.

void RaiseDoubleClickEvent(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

A MouseEventArgs that contains the event data.

Remarks

This method can be called to raise the DoubleClick event.

RaiseMouseCaptureLostEvent(EventArgs)

Generates a MouseCaptureLost event for the object.

void RaiseMouseCaptureLostEvent(EventArgs e)
Parameter Type Description
e EventArgs

The EventArgs that contains the event data.

Remarks

This method can be called to raise the MouseCaptureLost event.

RaiseMouseDownEvent(MouseEventArgs)

Generates a MouseDown event for the object.

void RaiseMouseDownEvent(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

A MouseEventArgs that contains the event data.

Remarks

This method can be called to raise the MouseDown event.

RaiseMouseEnterEvent(MouseEventArgs)

Generates a MouseEnter event for the object.

void RaiseMouseEnterEvent(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

A MouseEventArgs that contains the event data.

Remarks

This method can be called to raise the MouseEnter event.

RaiseMouseHoverEvent(MouseEventArgs)

Generates a MouseHover event for the object.

void RaiseMouseHoverEvent(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

A MouseEventArgs that contains the event data.

Remarks

This method can be called to raise the MouseHover event.

RaiseMouseLeaveEvent(MouseEventArgs)

Generates a MouseLeave event for the object.

void RaiseMouseLeaveEvent(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

A MouseEventArgs that contains the event data.

Remarks

This method can be called to raise the MouseLeave event.

RaiseMouseMoveEvent(MouseEventArgs)

Generates a MouseMove event for the object.

void RaiseMouseMoveEvent(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

A MouseEventArgs that contains the event data.

Remarks

This method can be called to raise the MouseMove event.

RaiseMouseUpEvent(MouseEventArgs)

Generates a MouseUp event for the object.

void RaiseMouseUpEvent(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

A MouseEventArgs that contains the event data.

Remarks

This method can be called to raise the MouseUp event.

RaiseMouseWheelEvent(MouseEventArgs)

Generates a MouseWheel event for the object.

void RaiseMouseWheelEvent(MouseEventArgs e)
Parameter Type Description
e MouseEventArgs

A MouseEventArgs that contains the event data.

Remarks

This method can be called to raise the MouseWheel event.

ReleaseMouseCapture()

Releases the mouse capture, if any.

void ReleaseMouseCapture()