PopupMenuShowingEventArgs Class

Provides data for the TreeList.PopupMenuShowing event.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v18.1.dll

Declaration

C#

public class PopupMenuShowingEventArgs :
    EventArgs

VB.NET

Public Class PopupMenuShowingEventArgs
    Inherits EventArgs

Related API Members

PopupMenuShowingEventArgs is the data class for the following events:

• TreeList.PopupMenuShowing

Remarks

The PopupMenuShowingEventArgs objects are automatically created, initialized and passed to the TreeList.PopupMenuShowing event handlers.

Example

The following sample code handles the TreeList.PopupMenuShowing event for the following two purposes.

• Disables the summary footer context menu for the “Department” column.
• Removes the “Runtime columns customization” item of the column header context menu.

C#

using DevExpress.XtraTreeList;

private void treeList1_PopupMenuShowing(object sender, PopupMenuShowingEventArgs e) {
    TreeList treeList = sender as TreeList;
    TreeListHitInfo hitInfo = treeList.CalcHitInfo(e.Point);

    // prohibiting summary footer menu for the "Department" column
    if (hitInfo.HitInfoType == HitInfoType.SummaryFooter &&
      hitInfo.Column.Caption == "Department")
        e.Allow = false;

    // removing the "Runtime columns customization" item of the column header menu
    if (hitInfo.HitInfoType == HitInfoType.Column) {
        string caption = TreeListLocalizer.Active.GetLocalizedString(GetMenuColumnCustomizationStringId(treeList));
        e.Menu.Items.Remove(e.Menu.Items.FirstOrDefault(x => x.Caption == caption));
    }
}

private TreeListStringId GetMenuColumnCustomizationStringId(TreeList treeList) {
    if (treeList.OptionsView.ShowBandsMode == DefaultBoolean.True || (treeList.OptionsView.ShowBandsMode == DefaultBoolean.Default && treeList.Bands.Count > 0))
        return TreeListStringId.MenuColumnBandCustomization;
    return TreeListStringId.MenuColumnColumnCustomization;
}

VB.NET

Imports DevExpress.XtraTreeList

Private Sub treeList1_PopupMenuShowing(ByVal sender As Object, ByVal e As PopupMenuShowingEventArgs)
    Dim treeList As TreeList = TryCast(sender, TreeList)
    Dim hitInfo As TreeListHitInfo = treeList.CalcHitInfo(e.Point)

    ' prohibiting summary footer menu for the "Department" column
    If hitInfo.HitInfoType = HitInfoType.SummaryFooter AndAlso hitInfo.Column.Caption = "Department" Then
        e.Allow = False
    End If

    ' removing the "Runtime columns customization" item of the column header menu
    If hitInfo.HitInfoType = HitInfoType.Column Then
        Dim caption As String = TreeListLocalizer.Active.GetLocalizedString(GetMenuColumnCustomizationStringId(treeList))
        e.Menu.Items.Remove(e.Menu.Items.FirstOrDefault(Function(x) x.Caption = caption))
    End If
End Sub

Private Function GetMenuColumnCustomizationStringId(ByVal treeList As TreeList) As TreeListStringId
    If treeList.OptionsView.ShowBandsMode = DefaultBoolean.True OrElse (treeList.OptionsView.ShowBandsMode = DefaultBoolean.Default AndAlso treeList.Bands.Count > 0) Then
        Return TreeListStringId.MenuColumnBandCustomization
    End If
    Return TreeListStringId.MenuColumnColumnCustomization
End Function

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PopupMenuShowingEventArgs 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.

VB.NET

how-to-implement-the-cells-multi-selection-feature-in-treelist-e2795/VB/WindowsApplication1/Helper/BlockSelector.vb#L53

Private Sub fList_PopupMenuShowing(ByVal sender As Object, ByVal e As PopupMenuShowingEventArgs)
    Dim hi As TreeListHitInfo = fList.CalcHitInfo(e.Point)

implementing-context-menus-for-treelist-nodes-e847/VB/Form1.vb#L48

Private Sub treeList1_PopupMenuShowing(ByVal sender As System.Object, ByVal e As DevExpress.XtraTreeList.PopupMenuShowingEventArgs) Handles treeList1.PopupMenuShowing
    If TypeOf e.Menu Is DevExpress.XtraTreeList.Menu.TreeListNodeMenu Then

C#

implementing-context-menus-for-treelist-nodes-e847/CS/Form1.cs#L45

private void treeList1_PopupMenuShowing(object sender, PopupMenuShowingEventArgs e) {
    if(e.Menu is TreeListNodeMenu) {

Inheritance

Object

EventArgs

PopupMenuShowingEventArgs

TreeListMenuEventArgs