This documentation is archived and is not being maintained.

ButtonBase.OnMouseDown Method

This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.

Raises the OnMouseDown event.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

protected override void OnMouseDown(
	MouseEventArgs mevent
)

Parameters

mevent
Type: System.Windows.Forms.MouseEventArgs

A MouseEventArgs that contains the event data.

Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

The OnMouseDown 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.

NoteNote:

Do not call OnMouseDown if the button is disabled (this includes calls to the base class's OnMouseDown method when you override OnMouseDown in a derived class). When disabling the button in an override of OnMouseDown, call the base class's OnMouseDown method before disabling the button, or do not call it at all.

Notes to Inheritors:

When overriding OnMouseDown in a derived class, be sure to call the base class's OnMouseDown method so that registered delegates receive the event.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: