Glyph.GetHitTest(Point) Method

Reference

Definition

Namespace:: System.Windows.Forms.Design.Behavior

Assembly:: System.Design.dll

Assembly:: System.Windows.Forms.Design.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides hit test logic.

public:
 abstract System::Windows::Forms::Cursor ^ GetHitTest(System::Drawing::Point p);

public abstract System.Windows.Forms.Cursor GetHitTest (System.Drawing.Point p);

public abstract System.Windows.Forms.Cursor? GetHitTest (System.Drawing.Point p);

abstract member GetHitTest : System.Drawing.Point -> System.Windows.Forms.Cursor

Public MustOverride Function GetHitTest (p As Point) As Cursor

Parameters

p: Point

A point to hit-test.

Returns

Cursor

A Cursor if the Glyph is associated with p; otherwise, null.

Examples

The following example demonstrates how to override the GetHitTest to see if the point is within this glyph. This code example is part of a larger example provided for the BehaviorService class.

public:
    virtual Cursor^ GetHitTest(Point p) override
    {
        // GetHitTest is called to see if the point is
        // within this glyph.  This gives us a chance to decide
        // what cursor to show.  Returning null from here means
        // the mouse pointer is not currently inside of the
        // glyph.  Returning a valid cursor here indicates the
        // pointer is inside the glyph, and also enables our
        // Behavior property as the active behavior.
        if (Bounds.Contains(p))
        {
            return Cursors::Hand;
        }
        return nullptr;
    }

public override Cursor GetHitTest(Point p)
{
    // GetHitTest is called to see if the point is
    // within this glyph.  This gives us a chance to decide
    // what cursor to show.  Returning null from here means
    // the mouse pointer is not currently inside of the glyph.
    // Returning a valid cursor here indicates the pointer is
    // inside the glyph, and also enables our Behavior property
    // as the active behavior.
    if (Bounds.Contains(p))
    {
        return Cursors.Hand;
    }

    return null;
}

Public Overrides Function GetHitTest(ByVal p As Point) As Cursor
    ' GetHitTest is called to see if the point is
    ' within this glyph.  This gives us a chance to decide
    ' what cursor to show.  Returning null from here means
    ' the mouse pointer is not currently inside of the glyph.
    ' Returning a valid cursor here indicates the pointer is
    ' inside the glyph,and also enables our Behavior property
    ' as the active behavior.
    If Bounds.Contains(p) Then
        Return Cursors.Hand
    End If

    Return Nothing

End Function

Remarks

The GetHitTest method is an abstract method that forces Glyph implementations to provide hit test logic. Given any point, if the Glyph has decided to be involved with that location, it will need to return a valid Cursor. Otherwise, returning null will cause the BehaviorService to ignore the location.

Applies to

Share via