TreeList.ShowTreeListMenu Event

OBSOLETE

You should use the 'PopupMenuShowing' instead

Allows you to customize the default menus for column headers, summary footers and nodes.

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v19.2.dll

Declaration

C#

[Browsable(false)]
[Obsolete("You should use the 'PopupMenuShowing' instead", false)]
public event TreeListMenuEventHandler ShowTreeListMenu

VB.NET

<Browsable(False)>
<Obsolete("You should use the 'PopupMenuShowing' instead", False)>
Public Event ShowTreeListMenu As TreeListMenuEventHandler

Event Data

The ShowTreeListMenu event's data class is TreeListMenuEventArgs. The following properties provide information specific to this event:

Property	Description
Allow	Gets or sets if display of the menu is allowed. Inherited from PopupMenuShowingEventArgs.
Menu	Gets or sets the control’s popup menu that will be shown. Inherited from PopupMenuShowingEventArgs.
Point	Gets the position where the menu is to be invoked. Inherited from PopupMenuShowingEventArgs.

Remarks

Use the TreeList.PopupMenuShowing event instead.

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 snippet (auto-collected from DevExpress Examples) contains a reference to the ShowTreeListMenu event.

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-allow-an-end-user-to-rename-treelistcolumn-at-runtime-e2713/CS/WindowsApplication3/TreeListColumnMenuExtender.cs#L34

public void EnableRenameColumnOption() {
    treeList.ShowTreeListMenu += OnShowTreeListMenu;
    renameEditor.Validated += OnRenameEditorValidated;

VB.NET

how-to-allow-an-end-user-to-rename-treelistcolumn-at-runtime-e2713/VB/WindowsApplication3/TreeListColumnMenuExtender.vb#L34

Public Sub EnableRenameColumnOption()
    AddHandler treeList.ShowTreeListMenu, AddressOf OnShowTreeListMenu
    AddHandler renameEditor.Validated, AddressOf OnRenameEditorValidated