HeaderPane
Main
Hide
Share Link
Print

HitTest Method, SftMask Object

Determines the area at a given location.

Syntax

C#bool Success = object.HitTest(float x, float y, out SftMaskAreaConstants Area);
VB.NETSuccess = object.HitTest(ByVal x As Single, ByVal y As Single, ByRef Area As SftMaskAreaConstants) As Boolean
C++VARIANT_BOOL Success = object->HitTest(float x, float y, enum SftMaskAreaConstants* Area);
CHRESULT object->raw_HitTest(float x, float y, enum SftMaskAreaConstants* Area, VARIANT_BOOL* Success);

object

A SftMask object.

x

An expression that evaluates to the x coordinate to be tested. The units used depend on the container used (e.g., Visual C++ uses pixels).

y

An expression that evaluates to the y coordinate to be tested. The units used depend on the container used (e.g., Visual C++ uses pixels).

Area

Returns the area description where the coordinates x, y are located.

AreaValueDescription
areaSftMaskCaption0Caption area
areaSftMaskEdit1Edit control (i.e., the editable portion of the control)
areaSftMaskSpin2Up/down buttons
areaSftMaskDropDown3Drop down button
areaSftMaskEllipse4Ellipse button
areaSftMaskError5Error image

Success

Returns True if the coordinates x, y are located in the control. If the coordinates are not located in one of the areas, False is returned and Area is set to -1.

Comments

The HitTest method determines the area at a given location.

The general area where the coordinates described by x, y are located in the control (relative to the top, left corner of the control) is returned in Area.

HitTestPix can be used if pixel coordinates are desired.

HitTestV is used for languages such as VBScript, which are limited by requiring Variant arguments and do not support strongly typed arguments for return values.

See Also SftMask Object | Object Hierarchy


Last Updated 11/15/2026 - (email)
© 2026 Softel vdm, Inc.