ControlDesigner.GetHitTest(Point) Method

Definition

Namespace:

System.Windows.Forms.Design

Assembly:

System.Windows.Forms.Design.dll

Source:

ControlDesigner.cs

Indicates whether a mouse click at the specified point should be handled by the control.

protected:
 virtual bool GetHitTest(System::Drawing::Point point);

protected virtual bool GetHitTest (System.Drawing.Point point);

abstract member GetHitTest : System.Drawing.Point -> bool
override this.GetHitTest : System.Drawing.Point -> bool

Protected Overridable Function GetHitTest (point As Point) As Boolean

Parameters

point

Point

A Point indicating the position at which the mouse was clicked, in screen coordinates.

Returns

Boolean

true if a click at the specified point is to be handled by the control; otherwise, false.

Remarks

The GetHitTest method determines whether a click at the specified point should be passed to the control, while the control is in design mode. You can override and implement this method to enable your control to receive clicks in the design-time environment.

Note

You can pass a point in screen coordinates to the PointToClient method of the Control class to obtain the coordinates of the point relative to the upper-left corner of the control.

The GetHitTest method is called in response to the WM_NCHITTEST message, so it is called on each mouse move.