HeaderPane
Main
Hide
Share Link
Print

HitTestPix Method, SftTreeItems Object

Returns the index of the item found at given coordinates.

Syntax

C#int ItemIndex = object.HitTestPix(int XPosPix, int YPosPix);
VB.NETItemIndex = object.HitTestPix(ByVal XPosPix As Integer, ByVal YPosPix As Integer) As Integer
C++long ItemIndex = object->HitTestPix(OLE_XPOS_PIXELS XPosPix, OLE_YPOS_PIXELS YPosPix);
CHRESULT object->raw_HitTestPix(OLE_XPOS_PIXELS XPosPix, OLE_YPOS_PIXELS YPosPix, long* ItemIndex);
VBItemIndex = object.HitTestPix(ByVal XPosPix As OLE_XPOS_PIXELS, ByVal YPosPix As OLE_YPOS_PIXELS) As Long

object

A SftTreeItems object.

XPosPix

The x coordinate to be tested in pixels.

YPosPix

The y coordinate to be tested in pixels.

ItemIndex

Returns the index of the item found at given coordinates. -1 is returned if no item is found.

Comments

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

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

If an item is found at the coordinates (xPosPix, yPosPix), 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 HitTestPix method can be used during a DragOver or OLEDragOver event to determine which item is currently the target of the drag & drop operation. The CalcCellFromPosPix or CalcIndexFromPosPix methods can also be used.

See Also SftTreeItems Object | Object Hierarchy


Last Updated 11/03/2026 - (email)
© 2026 Softel vdm, Inc.