HitTest Method, SftTreeItems Object


	SftTreeItems.HitTest Method	Softel vdm, Inc.

Returns the index of the item found at given coordinates.

Syntax

		VB.NET	ItemIndex = object.HitTest(ByVal xPos As Single, ByVal yPos As Single) As Integer
		VB	ItemIndex = object.HitTest(ByVal xPos As Single, ByVal yPos As Single) As Long
		C#.NET	int ItemIndex = object.HitTest(float xPos, float yPos);
		VC++	long ItemIndex = object->HitTest(float xPos, float yPos);
		C	HRESULT object->raw_HitTest(float xPos, float yPos, long* ItemIndex);
		Delphi	ItemIndex := object.HitTest(xPos : Single; yPos : Single) : Integer;

object

A SftTreeItems object.

xPos

The x coordinate to be tested. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.

yPos

The y coordinate to be tested. The units used depend on the container (Visual Basic, Visual C++, etc.) and the coordinate system used.

ItemIndex

Returns the zero-based index of the item found at the specified coordinates. -1 is returned if no item is found.

Comments

The HitTest method returns the index of the item found at given coordinates.

The Items.HitTest and Items.HitTestPix methods are synonyms, but may use different coordinate systems.

If an item is found at the coordinates (xPos, yPos), the zero-based index of the item is returned. If the specified coordinates are located in the row/column header or column header area, -1 is returned. If the coordinates are located in the tree control's client area, below the last item displayed, the zero-based index of the last item + 1 is returned, which is equal to the number of items in the tree control.

The HitTest method can be used during a DragOver or OLEDragOver event to determine which item is currently the target of the drag & drop operation. The CalcCellFromPos or CalcIndexFromPos methods can also be used.