SftButton/OCX 2.5

SftButton.HitTestPix Method

Softel vdm, Inc.

Determines the area at a given location.

Syntax       

VB.NET

Success = object.HitTestPix(ByVal xPix As Integer, ByVal yPix As Integer, ByRef Area As SftButtonAreaConstants)  As Boolean

VB

Success = object.HitTestPix(ByVal xPix As Long, ByVal yPix As Long, Area As SftButtonAreaConstants)  As Boolean

C#.NET

bool Success = object.HitTestPix(int xPix, int yPix, out SftButtonAreaConstants Area);

VC++

VARIANT_BOOL Success = object->HitTestPix(long xPix, long yPix, enum SftButtonAreaConstants* Area);

C

HRESULT object->raw_HitTestPix(long xPix, long yPix, enum SftButtonAreaConstants* Area, VARIANT_BOOL* Success);

Delphi

Success := object.HitTestPix(xPix : Integer; yPix : Integer; out Area : TOleEnum)   : WordBool;

object

A SftButton object.

xPix

An expression that evaluates to the x-coordinate to be tested. The units used are pixels.

yPix

An expression that evaluates to the y-coordinate to be tested. The units used are 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 xPix, yPix are located within the control. 

Comments

The HitTestPix method determines the area at a given location.

The general area where the coordinates described by xPix, yPix are 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