ScrollableControl.OnMouseWheel(MouseEventArgs) Method

Definition

Raises the MouseWheel event.

protected:
 override void OnMouseWheel(System::Windows::Forms::MouseEventArgs ^ e);
protected override void OnMouseWheel (System.Windows.Forms.MouseEventArgs e);
override this.OnMouseWheel : System.Windows.Forms.MouseEventArgs -> unit
Protected Overrides Sub OnMouseWheel (e As MouseEventArgs)

Parameters

e
MouseEventArgs

A MouseEventArgs that contains the event data.

Remarks

If the vertical scroll bar is visible, which means that the VScroll property is set to true, the mouse wheel scrolls through the ScrollableControl control vertically. However, if only the horizontal scroll bar is visible, which means that the VScroll is set to false and the HScroll property to set to true, the mouse wheel scrolls horizontally.

Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.

The OnMouseWheel method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors

When overriding OnMouseWheel(MouseEventArgs) in a derived class, be sure to call the base class' OnMouseWheel(MouseEventArgs) method so that registered delegates receive the event.

Applies to

See also