SftOptions.HitTest Method	Softel vdm, Inc.

Determines the entry at the given cursor coordinates.

Syntax       

		VB.NET	Name = object.HitTest(ByVal xPos As Single, ByVal yPos As Single)  As String
		VB	Name = object.HitTest(ByVal xPos As Single, ByVal yPos As Single)  As String
		C#.NET	string Name = object.HitTest(float xPos, float yPos);
		VC++	_bstr_t Name = object->HitTest(float xPos, float yPos);
		C	HRESULT object->raw_HitTest(float xPos, float yPos, BSTR* Name);
		Delphi	Name := object.HitTest(xPos : Single; yPos : Single)   : WideString;

object

A SftOptions object.

xPos

The x coordinate of the location for which the entry name is to be returned. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.

yPos

The y coordinate of the location for which the entry name is to be returned. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.

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 HitTest 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.

The equivalent HitTestPix method uses pixels as xPos and yPos arguments.

See Also  SftOptions Object | Object Hierarchy