RichEditControl.PopupMenuShowing Event

Allows you to customize the Rich Text Editor’s context menus.

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v23.2.dll

NuGet Package: DevExpress.Wpf.RichEdit

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
Customizations	Provides access to the collection of context menu customization actions.
Menu	Gets or sets the context menu for which the event is raised.
MenuType	Indicates a document element for which the context menu is invoked.

Remarks

Use the PopupMenuShowingEventArgs.Customizations property to add or remove menu items. The PopupMenuShowingEventArgs.MenuType property allows you to determine for which element (document text, a header or footer, a picture, etc.) the menu is invoked. To obtain the context menu for which the event is raised, use the PopupMenuShowingEventArgs.Menu property.

The example below customizes the Text context menu as follows:

• Creates new Highlight Selection and Insert Picture items
• Removes the Increase Indent and Decrease Indent items

XAML

<dxre:RichEditControl Name="richTextEditor" 
                      PopupMenuShowing="richTextEditor_PopupMenuShowing">

C#

using DevExpress.XtraRichEdit.API.Native;
using DevExpress.Xpf.RichEdit;
using DevExpress.Xpf.Bars;
using DevExpress.Xpf.RichEdit.Menu;
using DevExpress.XtraRichEdit.Commands;
// ...

private void richTextEditor_PopupMenuShowing(object sender, PopupMenuShowingEventArgs e) {
    // Check whether the event is raised for document text.
    if (e.MenuType == RichEditMenuType.Text) {
        // Create a menu item to insert a picture
        // and bind this item to the Rich Text Editor's command.
        e.Customizations.Add(new BarButtonItem() {
            Command = RichEditUICommand.InsertFloatingPicture,
            Content = "Insert Picture",
            CommandParameter = richTextEditor
        });

        // Create a custom menu item to highlight selected text.
        var menuItem = new BarButtonItem() {
            Name = "highlightSelectionItem",
            Content = "Highlight Selection"
        };
        menuItem.ItemClick += MenuItem_ItemClick; ;
        e.Customizations.Add(menuItem);
    }

    // Remove the "Increase Indent" item from the menu.
    e.Customizations.Add(new RemoveRichEditCommandAction() {
        Id = RichEditCommandId.IncreaseIndent
    });

    // Remove the "Decrease Indent" item from the menu.
    e.Customizations.Add(new RemoveRichEditCommandAction() {
        Id = RichEditCommandId.DecreaseIndent
    });
}

private void MenuItem_ItemClick(object sender, ItemClickEventArgs e) {
    var selectedRanges = richTextEditor.Document.Selections;
    foreach (var range in selectedRanges) {
        var charProps = richTextEditor.Document.BeginUpdateCharacters(range);
        charProps.BackColor = System.Drawing.Color.Yellow;
        richTextEditor.Document.EndUpdateCharacters(charProps);
    }
}

VB.NET

Imports DevExpress.XtraRichEdit.API.Native
Imports DevExpress.Xpf.RichEdit
Imports DevExpress.Xpf.Bars
Imports DevExpress.Xpf.RichEdit.Menu
Imports DevExpress.XtraRichEdit.Commands
' ...

Private Sub richTextEditor_PopupMenuShowing(ByVal sender As Object, ByVal e As PopupMenuShowingEventArgs)
    ' Check whether the event is raised for document text.
    If e.MenuType = RichEditMenuType.Text Then
        ' Create a menu item to insert a picture
        ' and bind this item to the Rich Text Editor's command.
        e.Customizations.Add(New BarButtonItem() With {
            .Command = RichEditUICommand.InsertFloatingPicture,
            .Content = "Insert Picture",
            .CommandParameter = richTextEditor
        })

        ' Create a custom menu item to highlight selected text.
        Dim menuItem As New BarButtonItem() With {
            .Name = "highlightSelectionItem",
            .Content = "Highlight Selection"
        }
        menuItem.ItemClick += MenuItem_ItemClick
        e.Customizations.Add(menuItem)
    End If

    ' Remove the "Increase Indent" item from the menu.
    e.Customizations.Add(New RemoveRichEditCommandAction() With {
        .Id = RichEditCommandId.IncreaseIndent})

    ' Remove the "Decrease Indent" item from the menu.
    e.Customizations.Add(New RemoveRichEditCommandAction() With {
        .Id = RichEditCommandId.DecreaseIndent})
End Sub

Private Sub MenuItem_ItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    Dim selectedRanges As SelectionCollection = richTextEditor.Document.Selections
    For Each range As DocumentRange In selectedRanges
        Dim charProps As CharacterProperties = richTextEditor.Document.BeginUpdateCharacters(range)
        charProps.BackColor = System.Drawing.Color.Yellow
        richTextEditor.Document.EndUpdateCharacters(charProps)
    Next range
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.

XAML

wpf-rich-text-editor-customize-context-menu/CS/ContextMenuCustomization/MainWindow.xaml#L38

<dxre:RichEditControl x:Name="richEdit" CommandBarStyle="Empty" BarManager="{Binding ElementName=barManager1, Mode=OneTime}" PopupMenuShowing="RichEditPopupMenuShowing">
    <dxre:RichEditControl.MenuCustomizations>