PopupMenuShowingEventArgs.HitInfo Property

Provides access to information about the clicked visual element.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v23.2.dll

NuGet Packages: DevExpress.Win.Navigation, DevExpress.Win.TreeList

Declaration

C#

public TreeListHitInfo HitInfo { get; }

VB.NET

Public ReadOnly Property HitInfo As TreeListHitInfo

Property Value

Type	Description
TreeListHitInfo	An object that contains information about a visual element.

Remarks

The Tree List shows a context menu when the user right-clicks within the following areas:

• Column Header — the control shows the Column Header Context Menu if the EnableColumnMenu option is enabled. The menu contains commands related to columns: sorting, filtering, etc.
• Node — the control shows the Node Context Menu if the EnableNodeMenu option is enabled. The menu contains commands related to nodes: expand, collapse, create a new node, etc.
• Group Footer, Summary Footer — the control shows the Footer Context Menu if the EnableFooterMenu option is enabled. The menu contains commands related to summaries: sum, min, average, etc.
• Empty Area — the menu invoked with a right-click below the tree list’s nodes. The default empty-area context menu does not contain any commands. Use the PopupMenuShowing event to populate the menu.

The HitInfo and MenuType event arguments allow you to determine the clicked visual element and the type of the menu that is about to be displayed.

Example

The PopupMenuShowing event is raised before a context menu is shown and allows you to customize it. The HitInfo event argument is set to Empty when a user right-clicked the empty area.

The code below shows how to add the Full Collapse and Full Expand commands to the empty-area context menu.

C#

using DevExpress.Utils.Menu;
using DevExpress.Utils.Svg;
using DevExpress.XtraTreeList;
using DevExpress.XtraTreeList.Localization;

treeList1.PopupMenuShowing += OnPopupMenuShowing;

void OnPopupMenuShowing(object sender, PopupMenuShowingEventArgs e) {
    TreeList treeList = sender as TreeList;
    if(e.HitInfo.HitInfoType == HitInfoType.Empty) {
        string expandAllCaption = TreeListLocalizer.Active.GetLocalizedString(TreeListStringId.MenuNodeExpandAll);
        DXMenuItem expandAll = new DXMenuItem(expandAllCaption, (ss, ee) => treeList.ExpandAll());
        expandAll.ImageOptions.SvgImage = CommonSvgImages.Get(CommonSvgImages.Column.ExpandAll);
        e.Menu.Items.Add(expandAll);
        string collapseAllCaption = TreeListLocalizer.Active.GetLocalizedString(TreeListStringId.MenuNodeCollapseAll);
        DXMenuItem collapseAll = new DXMenuItem(collapseAllCaption, (ss, ee) => treeList.CollapseAll());
        collapseAll.ImageOptions.SvgImage = CommonSvgImages.Get(CommonSvgImages.Column.CollapseAll);
        e.Menu.Items.Add(collapseAll);
        e.Allow = true;
    }
}

VB.NET

Imports DevExpress.Utils.Menu
Imports DevExpress.Utils.Svg
Imports DevExpress.XtraTreeList
Imports DevExpress.XtraTreeList.Localization

AddHandler treeList1.PopupMenuShowing, AddressOf OnPopupMenuShowing

Private Sub OnPopupMenuShowing(ByVal sender As Object, ByVal e As PopupMenuShowingEventArgs)
    Dim treeList As TreeList = TryCast(sender, TreeList)
    If e.HitInfo.HitInfoType = HitInfoType.Empty Then
        Dim expandAllCaption As String = TreeListLocalizer.Active.GetLocalizedString(TreeListStringId.MenuNodeExpandAll)
        Dim expandAll As New DXMenuItem(expandAllCaption, Sub(ss, ee) treeList.ExpandAll())
        expandAll.ImageOptions.SvgImage = CommonSvgImages.Get(CommonSvgImages.Column.ExpandAll)
        e.Menu.Items.Add(expandAll)
        Dim collapseAllCaption As String = TreeListLocalizer.Active.GetLocalizedString(TreeListStringId.MenuNodeCollapseAll)
        Dim collapseAll As New DXMenuItem(collapseAllCaption, Sub(ss, ee) treeList.CollapseAll())
        collapseAll.ImageOptions.SvgImage = CommonSvgImages.Get(CommonSvgImages.Column.CollapseAll)
        e.Menu.Items.Add(collapseAll)
        e.Allow = True
    End If
End Sub