NavBarHitInfo Class

Contains information about the control’s section located under a specified point.

Namespace: DevExpress.XtraNavBar

Assembly: DevExpress.XtraNavBar.v18.1.dll

Declaration

C#

public class NavBarHitInfo :
    ICloneable

VB.NET

Public Class NavBarHitInfo
    Implements ICloneable

Related API Members

The following members accept/return NavBarHitInfo objects:

• NavBarControl.CalcHitInfo(Point)

Remarks

The NavBarControl control provides you with the ability to determine the element of a control which resides under a specified test point. Use the NavBarControl.CalcHitInfo method for this purpose. It takes the test point as a parameter and returns the NavBarHitInfo object containing the desired information.

Properties of the NavBarHitInfo object allow you to obtain two kinds of information. The first is information about the type of element residing under a specified point. It can, for instance, be obtained via the NavBarHitInfo.HitTest property. You can also obtain objects representing the group and link located under the test point. Use the NavBarHitInfo.Group and NavBarHitInfo.Link properties for this purpose.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the NavBarHitInfo class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-provide-supertooltip-with-design-time-support-for-any-control-e2311/CS/E2311/Helper/MyNavBarSuperTipHelper.cs#L28

{
    NavBarHitInfo hi = navBar.CalcHitInfo(e.ControlMousePosition);

which-event-to-use-when-collapsing-expanding-the-groups-in-the-navbars-explorer-views-e782/CS/Form1.cs#L127

if(e.Button == MouseButtons.Left) {
    NavBarHitInfo info = (sender as NavBarControl).CalcHitInfo(new Point(e.X, e.Y));
    if(info.InGroupButton && !info.Group.Expanded) {

how-to-add-a-checkbox-to-the-navbar-groups-caption-e2061/CS/WindowsApplication1/NavBarGroupStateHelper.cs#L135

{
    NavBarHitInfo hi = NavBarControl.CalcHitInfo(p);
    if (hi.Group == null) return false; ;

how-to-show-the-navpaneform-programmatically-e2199/CS/WindowsApplication1/Form1.cs#L43

var args = (MouseEventArgs)e;
var hi = navBarControl1.CalcHitInfo(args.Location);
if (hi.InGroupCaption && hi.Group == navBarControl1.ActiveGroup)

VB.NET

how-to-provide-supertooltip-with-design-time-support-for-any-control-e2311/VB/E2311/Helper/MyNavBarSuperTipHelper.vb#L25

If navBar IsNot Nothing Then
    Dim hi As NavBarHitInfo = navBar.CalcHitInfo(e.ControlMousePosition)

which-event-to-use-when-collapsing-expanding-the-groups-in-the-navbars-explorer-views-e782/VB/Form1.vb#L121

If e.Button = MouseButtons.Left Then
    Dim info As NavBarHitInfo = (TryCast(sender, NavBarControl)).CalcHitInfo(New Point(e.X, e.Y))
    If info.InGroupButton AndAlso (Not info.Group.Expanded) Then

how-to-add-a-checkbox-to-the-navbar-groups-caption-e2061/VB/WindowsApplication1/NavBarGroupStateHelper.vb#L133

Private Function IsCheckBox(ByVal p As Point) As Boolean
    Dim hi As NavBarHitInfo = NavBarControl.CalcHitInfo(p)
    If hi.Group Is Nothing Then

Inheritance

Object

NavBarHitInfo