Disable and Remove Particular Items in the Standard Menus

• Nov 13, 2018
• 2 minutes to read

Disable and Remove Particular Items in the Standard Menus

When any of the standard context menus is invoked, the TreeList.PopupMenuShowing event fires. It allows the current menu to be accessed via the Menu parameter, and then modified. For instance, it’s easy to prevent the menu from being displayed, or disable and/or remove certain menu items.

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