RichEditControl.PopupMenuShowing Event

Occurs before a context (popup) menu is created for the control’s document every time a context menu is being invoked.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v19.2.dll

Declaration

C#

public event PopupMenuShowingEventHandler PopupMenuShowing

VB.NET

Public Event PopupMenuShowing As PopupMenuShowingEventHandler

Event Data

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

Property	Description
Menu	Gets or sets the popup (context) menu for which this event was raised.
MenuType	Gets a visual element for which the popup menu is invoked.

Remarks

Handle the PopupMenuShowing event to modify items in the context menu. The current context menu can be accessed via the PopupMenuShowingEventArgs.Menu property.

Example

This example demonstrates how to handle the RichEditControl.PopupMenuShowing event to customize the RichEditControl‘s context menu. You can remove and disable the existing items, and add new ones using the RichEdit commands.

Note

The CommandPopupMenu<T>.EnableMenuItem method does not enable the context menu item if you set the corresponding command’s ICommandUIState.Enabled property to false.

The RichEditMenuType enumeration lists all available context menu types. The following sample modifies the RichEditMenuType.TableCell menu, invoked by right-clicking the table cell.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-the-winforms-richeditcontrol-popup-menu-t541476

Form1.cs

private void richEditControl_PopupMenuShowing(object sender, PopupMenuShowingEventArgs e)
{
    if ((e.MenuType & RichEditMenuType.TableCell) != 0)
    {
        // Remove the "Paste" menu item:
        e.Menu.RemoveMenuItem(RichEditCommandId.PasteSelection);

        // Disable the "Hyperlink..." menu item:
        e.Menu.DisableMenuItem(RichEditCommandId.CreateHyperlink);

        // Create a RichEdit command, which inserts an inline picture into a document:
        IRichEditCommandFactoryService service = (IRichEditCommandFactoryService)richEditControl.GetService(typeof(IRichEditCommandFactoryService));
        RichEditCommand cmd = service.CreateCommand(RichEditCommandId.InsertPicture);

        //Create a menu item for the new command:
        RichEditMenuItemCommandWinAdapter menuItemCommandAdapter = new RichEditMenuItemCommandWinAdapter(cmd);
        RichEditMenuItem menuItem = (RichEditMenuItem)menuItemCommandAdapter.CreateMenuItem(DevExpress.Utils.Menu.DXMenuItemPriority.Normal);
        menuItem.BeginGroup = true;
        e.Menu.Items.Add(menuItem);

        // Insert a new item into the Richedit popup menu and handle its click event:
        RichEditMenuItem myItem = new RichEditMenuItem("Highlight Selection", new EventHandler(MyClickHandler));
        e.Menu.Items.Add(myItem);
    }
}

Form1.vb

Private Sub richEditControl_PopupMenuShowing(ByVal sender As Object, ByVal e As PopupMenuShowingEventArgs) Handles richEditControl.PopupMenuShowing
    If (e.MenuType And RichEditMenuType.TableCell) <> 0 Then
        ' Remove the "Paste" menu item:
        e.Menu.RemoveMenuItem(RichEditCommandId.PasteSelection)

        ' Disable the "Hyperlink..." menu item:
        e.Menu.DisableMenuItem(RichEditCommandId.CreateHyperlink)

        ' Create a RichEdit command, which inserts an inline picture into a document:
        Dim service As IRichEditCommandFactoryService = DirectCast(richEditControl.GetService(GetType(IRichEditCommandFactoryService)), IRichEditCommandFactoryService)
        Dim cmd As RichEditCommand = service.CreateCommand(RichEditCommandId.InsertPicture)

        'Create a menu item for the new command:
        Dim menuItemCommandAdapter As New RichEditMenuItemCommandWinAdapter(cmd)
        Dim menuItem As RichEditMenuItem = CType(menuItemCommandAdapter.CreateMenuItem(DevExpress.Utils.Menu.DXMenuItemPriority.Normal), RichEditMenuItem)
        menuItem.BeginGroup = True
        e.Menu.Items.Add(menuItem)

        ' Insert a new item into the Richedit popup menu and handle its click event:
        Dim myItem As New RichEditMenuItem("Highlight Selection", New EventHandler(AddressOf MyClickHandler))
        e.Menu.Items.Add(myItem)
    End If
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PopupMenuShowing 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-integrate-spellchecker-menu-items-into-the-xtrarichedit-context-menu-e1758/CS/RichEditPopupMenu/Form1.cs#L45

    InitializeComponent();
    richEditControl1.PopupMenuShowing+=new DevExpress.XtraRichEdit.PopupMenuShowingEventHandler(richEditControl1_PopupMenuShowing);
}

VB.NET

how-to-integrate-spellchecker-menu-items-into-the-xtrarichedit-context-menu-e1758/VB/RichEditPopupMenu/Form1.vb#L47

    InitializeComponent()
    AddHandler richEditControl1.PopupMenuShowing, AddressOf richEditControl1_PopupMenuShowing
End Sub