Export (0) Print
Expand All

Shape.OnMouseClick Method

Raises the MouseClick event.

Namespace:  Microsoft.VisualBasic.PowerPacks
Assembly:  Microsoft.VisualBasic.PowerPacks.Vs (in Microsoft.VisualBasic.PowerPacks.Vs.dll)

protected internal virtual void OnMouseClick(
	MouseEventArgs e
)

Parameters

e
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 OnMouseClick method also enables 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 you override OnMouseClick in a derived class, be sure to call the OnMouseClick method of the base class so that registered delegates receive the event.

The following example is a method that is executed when the Click event occurs. The Shape class has several methods with the name pattern OnEventName that execute methods when the EventName event occurs. (EventName represents the name of the corresponding event.)

The following example demonstrates how to override the OnClick and OnLostFocus methods in a class that derives from LineShape.

public class HighlightLine :
    LineShape
{
    protected override void OnClick(EventArgs e)
    {
        // Change the color of the line when clicked. 
        this.BorderColor = Color.Red;
        base.OnClick(e);
    }
    protected override void OnLostFocus(System.EventArgs e)
    {
        // Change the color of the line when focus is changed. 
        this.BorderColor = Color.Black;
        base.OnLostFocus(e);
    }
}

Show:
© 2014 Microsoft