SftOptions 1.0

SftOptions.HitTestPix Method

Softel vdm, Inc.

Determines the entry at the given cursor coordinates.

Syntax       

VB.NET

Name = object.HitTestPix(ByVal xPosPix As OLE_XPOS_PIXELS, ByVal yPosPix As OLE_YPOS_PIXELS)  As String

VB

Name = object.HitTestPix(ByVal xPosPix As OLE_XPOS_PIXELS, ByVal yPosPix As OLE_YPOS_PIXELS)  As String

C#.NET

string Name = object.HitTestPix(OLE_XPOS_PIXELS xPosPix, OLE_YPOS_PIXELS yPosPix);

VC++

_bstr_t Name = object->HitTestPix(OLE_XPOS_PIXELS xPosPix, OLE_YPOS_PIXELS yPosPix);

C

HRESULT object->raw_HitTestPix(OLE_XPOS_PIXELS xPosPix, OLE_YPOS_PIXELS yPosPix, BSTR* Name);

Delphi

Name := object.HitTestPix(xPosPix : Integer; yPosPix : Integer)   : WideString;

object

A SftOptions object.

xPosPix

The x coordinate of the location for which the entry name is to be returned. The units used are pixels.

yPosPix

The y coordinate of the location for which the entry name is to be returned. The units used are pixels.

Name

Returns the entry name at the given cursor coordinates. If the coordinates describe the column header, "Header" is returned.  If the coordinates are not on an entry, "Empty Area" is returned.

Comments

The HitTestPix method determines the entry at the given cursor coordinates.

If an entry is found at the coordinates (x, y), the entry name (SftOptionsEntry.Name property) is returned.  The SftOptions.Entry property can be used to retrieve the SftOptionsEntry object.

See Also  SftOptions Object | Object Hierarchy


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