SpreadsheetControl.PopupMenuShowing Event

Occurs before a popup menu is created for the control’s document whenever a context menu is being invoked.

Namespace: DevExpress.Xpf.Spreadsheet

Assembly: DevExpress.Xpf.Spreadsheet.v19.2.dll

Declaration

C#

public event EventHandler<PopupMenuShowingEventArgs> PopupMenuShowing

VB.NET

Public Event PopupMenuShowing As EventHandler(Of PopupMenuShowingEventArgs)

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 a collection of customizations of the popup menu.
Menu	Gets or sets the popup menu for which the SpreadsheetControl.PopupMenuShowing event was raised.
MenuType	Indicates 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 customize the SpreadsheetControl’s context menu - remove the existing menu items and add new items.

Handle the SpreadsheetControl.PopupMenuShowing event. Use the PopupMenuShowingEventArgs.MenuType property to determine the visual element for which the popup menu is invoked.

To remove a menu item, create the RemoveSpreadsheetCommandAction object, set its ID to the ID of the command to remove and add that object to the PopupMenuShowingEventArgs.Customizations collection.

To add a new menu item, create a new BarButtonItem and add it to the PopupMenuShowingEventArgs.Customizations collection.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-the-popup-menu-of-the-wpf-spreadsheet-control-e5147.

MainWindow.xaml

<dxb:BarManager x:Name="barManager1" ToolbarGlyphSize="Small">
    <dxb:BarManager.Items>
        <dxb:BarButtonItem
            x:Name="customNewFile"
            Command="{Binding FileNew, Mode=OneTime, Source={StaticResource commands}}"
            Content="Custom Create New File" />
        <dxb:BarButtonItem
            x:Name="customMergeCells"
            Command="{Binding EditingMergeAndCenterCells, Mode=OneTime, Source={StaticResource commands}}"
            Content="Custom Merge Cells" />
    </dxb:BarManager.Items>
    <Grid>
        <dxsps:SpreadsheetControl
            x:Name="spreadsheetControl1"
            BarManager="{Binding ElementName=barManager1, Mode=OneTime}"
            PopupMenuShowing="SpreadsheetControlPopupMenuShowing">
            <dxsps:SpreadsheetControl.MenuCustomizations>
                <dxsps:SpreadsheetMenuCustomization MenuType="Cell">
                    <dxb:BarButtonItemLink dxb:BarItemLinkActionBase.ItemLinkIndex="0">
                        <dxb:BarButtonItemLink.BarItemName>
                            customMergeCells
                        </dxb:BarButtonItemLink.BarItemName>
                    </dxb:BarButtonItemLink>
                </dxsps:SpreadsheetMenuCustomization>
                <dxsps:SpreadsheetMenuCustomization>
                    <dxb:BarButtonItemLink dxb:BarItemLinkActionBase.ItemLinkIndex="1">
                        <dxb:BarButtonItemLink.BarItemName>
                            customNewFile
                        </dxb:BarButtonItemLink.BarItemName>
                    </dxb:BarButtonItemLink>
                </dxsps:SpreadsheetMenuCustomization>
                <dxsps:SpreadsheetMenuCustomization>
                    <dxb:BarItemLinkSeparator dxb:BarItemLinkActionBase.ItemLinkIndex="2" />
                </dxsps:SpreadsheetMenuCustomization>
                <dxsps:SpreadsheetMenuCustomization MenuType="ColumnHeading">
                    <dxsps:RemoveSpreadsheetCommandAction 
                        Id="{x:Static dxspscore:SpreadsheetCommandId.HideColumnsContextMenuItem}" />
                    <dxsps:RemoveSpreadsheetCommandAction 
                        Id="{x:Static dxspscore:SpreadsheetCommandId.UnhideColumnsContextMenuItem}" />
                </dxsps:SpreadsheetMenuCustomization>
            </dxsps:SpreadsheetControl.MenuCustomizations>
        </dxsps:SpreadsheetControl>
    </Grid>
</dxb:BarManager>

MainWindow.xaml.cs

private void SpreadsheetControlPopupMenuShowing(object sender, PopupMenuShowingEventArgs e)
{
    // Check whether this event was raised for a cell popup menu of the Spreadsheet control.
    if (e.MenuType == SpreadsheetMenuType.Cell)
    {
        // Remove the "Clear Contents" menu item.
        e.Customizations.Add(new RemoveSpreadsheetCommandAction() { Id = SpreadsheetCommandId.FormatClearContentsContextMenuItem });

        // Create a menu item for the Spreadsheet command, which inserts a picture into a worksheet.
        e.Customizations.Add(new BarButtonItem() { Command = SpreadsheetUICommand.InsertPicture,
            Content = "Insert Picture", CommandParameter = spreadsheetControl1 });

        // Create a custom menu item and handle its click event.
        BarButtonItem menuItem = new BarButtonItem();
        menuItem.Name = "customHighlightItem";
        menuItem.Content = "Highlight Selection";
        menuItem.ItemClick += new ItemClickEventHandler(customHighlightItem_ItemClick);
        e.Customizations.Add(menuItem);
    }
}

    private void customHighlightItem_ItemClick(object sender, ItemClickEventArgs e)
{
    // Fill the selection with the yellow color. 
    spreadsheetControl1.Selection.FillColor = System.Drawing.Color.Yellow;
}

MainWindow.xaml.vb

Private Sub SpreadsheetControlPopupMenuShowing(ByVal sender As Object, ByVal e As PopupMenuShowingEventArgs)
    ' Check whether this event was raised for a cell popup menu of the Spreadsheet control.
    If e.MenuType = SpreadsheetMenuType.Cell Then
        ' Remove the "Clear Contents" menu item.
        e.Customizations.Add(New RemoveSpreadsheetCommandAction() With {.Id = SpreadsheetCommandId.FormatClearContentsContextMenuItem})

        ' Create a menu item for the Spreadsheet command, which inserts a picture into a worksheet.
        e.Customizations.Add(New BarButtonItem() With { _
            .Command = SpreadsheetUICommand.InsertPicture, _
            .Content = "Insert Picture", _
            .CommandParameter = spreadsheetControl1 _
        })

        ' Create a custom menu item and handle its click event.
        Dim menuItem As New BarButtonItem()
        menuItem.Name = "customHighlightItem"
        menuItem.Content = "Highlight Selection"
        AddHandler menuItem.ItemClick, AddressOf customHighlightItem_ItemClick
        e.Customizations.Add(menuItem)
    End If
End Sub

    Private Sub customHighlightItem_ItemClick(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    ' Fill the selection with the yellow color. 
    spreadsheetControl1.Selection.FillColor = System.Drawing.Color.Yellow
    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#

wpf-spreadsheet-customize-context-menu/CS/MenuCustomization/MainWindow.xaml#L33

BarManager="{Binding ElementName=barManager1, Mode=OneTime}"
PopupMenuShowing="SpreadsheetControlPopupMenuShowing">
<dxsps:SpreadsheetControl.MenuCustomizations>