RibbonControl.ShowCustomizationMenu Event

Occurs before the RibbonControl’s Customization Menu is displayed.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v21.2.dll

Declaration

[DXCategory("Events")]
public event RibbonCustomizationMenuEventHandler ShowCustomizationMenu

Event Data

The ShowCustomizationMenu event's data class is DevExpress.XtraBars.Ribbon.RibbonCustomizationMenuEventArgs.

Remarks

The Customization Menu is displayed when a Ribbon Control is right-clicked. You can handle the ShowCustomizationMenu event to customize the menu or prevent it from being displayed.

The customization menu is not recreated each time it needs to be displayed. Therefore, if the menu has been modified in the ShowCustomizationMenu event handler, the changes will persist the next time the ShowCustomizationMenu event fires. So, before modifying the menu, you generally need to check whether modifications have been already made or not.

Example

The following example handles the RibbonControl.ShowCustomizationMenu event to customize the RibbonControl’s context menu.

The example hides the built-in “Add to Quick Access Toolbar” command, and adds a custom “About” command to the menu.

RibbonControl - Customized Context Menu

using DevExpress.XtraBars;
using DevExpress.XtraBars.Localization;

private void ribbonControl1_ShowCustomizationMenu(object sender, DevExpress.XtraBars.Ribbon.RibbonCustomizationMenuEventArgs e) {
    // Check if the context menu is invoked after a link is right-clicked.
    if (e.Link == null) return;
    // Locate and hide the "Add to Quick Access Toolbar" command in the context menu
    BarItemLink linkAddToQat = e.CustomizationMenu.ItemLinks.Where(link => link.Caption == BarLocalizer.Active.GetLocalizedString(BarString.RibbonToolbarAdd)).FirstOrDefault();
    linkAddToQat.Visible = false;

    // Check if a custom "About" command has already been created.
    BarItemLink menuAboutCommand = e.CustomizationMenu.ItemLinks.Where(link => link.Caption == "About").FirstOrDefault();
    // Add the "About" command.
    if (menuAboutCommand == null) {
        menuAboutCommand = e.CustomizationMenu.AddItem(GetAboutCommand());
        // Add a separator before the command.
        menuAboutCommand.BeginGroup = true;
    }
}

BarItem biAbout;
BarItem GetAboutCommand() {
    if (biAbout == null) {
        biAbout = new BarButtonItem();
        biAbout.Caption = "About";
        biAbout.ItemClick += new ItemClickEventHandler(biAbout_ItemClick);
        ribbonControl1.Items.Add(biAbout);
    }
    return biAbout;
}
// The method invoked when the "About" command is clicked.
void biAbout_ItemClick(object sender, ItemClickEventArgs e) {
    MessageBox.Show("About");
}
See Also