SftButton/OCX 2.5

SftButton.HitTest Method

Softel vdm, Inc.

Determines the area at a given location.

Syntax       

VB.NET

Success = object.HitTest(ByVal x As Single, ByVal y As Single, ByRef Area As SftButtonAreaConstants)  As Boolean

VB

Success = object.HitTest(ByVal x As Single, ByVal y As Single, Area As SftButtonAreaConstants)  As Boolean

C#.NET

bool Success = object.HitTest(float x, float y, out SftButtonAreaConstants Area);

VC++

VARIANT_BOOL Success = object->HitTest(float x, float y, enum SftButtonAreaConstants* Area);

C

HRESULT object->raw_HitTest(float x, float y, enum SftButtonAreaConstants* Area, VARIANT_BOOL* Success);

Delphi

Success := object.HitTest(x : Single; y : Single; out Area : TOleEnum)   : WordBool;

object

A SftButton 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 a value describing the area where the coordinates x, y are located.

Name

Value

Description

areaSftButtonButton

0

The coordinates are located within the button portion.

areaSftButtonDropDown

1

The coordinates are located within the drop down button portion.

Success

Returns True if the coordinates x, y are located within the control.

Comments

The HitTest method determines the area at a given location.

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

HitTest uses the units native to the container application (e.g., Visual Basic uses TWIPS by default, Visual C++ uses pixels). HitTestPix always uses pixels. HitTestV should be used when using Internet Explorer.


Feedback / comments / error reports for this topic
© 2008 - Softel vdm, Inc. - www.softelvdm.com