TreeList.CalcHitInfo(Point) Method

Returns information about the Tree List’s elements which are located at the specified point.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v22.2.dll

NuGet Package: DevExpress.Win.TreeList

Declaration

C#

public TreeListHitInfo CalcHitInfo(
    Point pt
)

VB.NET

Public Function CalcHitInfo(
    pt As Point
) As TreeListHitInfo

Parameters

Name	Type	Description
pt	Point	A Point structure which specifies test point coordinates relative to the Tree List’s top-left corner.

Returns

Type	Description
TreeListHitInfo	A TreeListHitInfo object which contains information about the Tree List’s elements located at the test point.

Remarks

Use the CalcHitInfo method to determine which element is located at a specified point. For instance, this can be used when handling the Tree List’s Click event to determine which element was clicked. In such instances, pass the current mouse pointer’s coordinates as the method’s parameter.

Example

The code below obtains the name of the element located under the mouse pointer. The MouseMove event is handled to track mouse pointer movement.

C#

using DevExpress.XtraTreeList;
//...
private void treeList1_MouseMove(object sender, System.Windows.Forms.MouseEventArgs e) {
   TreeListHitInfo hi = treeList1.CalcHitInfo(new Point(e.X, e.Y));
   string elementName = hi.HitInfoType.ToString();
   //...
}

VB.NET

Imports DevExpress.XtraTreeList
'...
Private Sub TreeList1_MouseMove(ByVal sender As Object, _
ByVal e As System.Windows.Forms.MouseEventArgs) _
Handles TreeList1.MouseMove
   Dim hi As TreeListHitInfo = TreeList1.CalcHitInfo(New Point(e.X, e.Y))
   Dim ElementName As String = hi.HitInfoType.ToString()
   ' ...
End Sub