HitTest Method, SftMask Object
Determines the area at a given location.
Syntax
| VB.NET | Success = object.HitTest(ByVal x As Single, ByVal y As Single, ByRef Area As SftMaskAreaConstants) As Boolean |
| VB | Success = object.HitTest(ByVal x As Single, ByVal y As Single, Area As SftMaskAreaConstants) As Boolean |
| C#.NET | bool Success = object.HitTest(float x, float y, out SftMaskAreaConstants Area); |
| VC++ | VARIANT_BOOL Success = object->HitTest(float x, float y, enum SftMaskAreaConstants* Area); |
| C | HRESULT 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 Basic uses TWIPS by default, 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 Basic uses TWIPS by default, Visual C++ uses pixels).
Area
Returns the area description where the coordinates x, y are located.
Success
Returns True if the coordinates x, y are located in the control.
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. For more information please see Using SftMask/OCX with Internet Explorer.
See Also SftMask Object | Object Hierarchy
On
Off