DataViewBase.ShowGridMenu Event

Enables you to customize the context menu.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v19.1.Core.dll

Declaration

C#

public event GridMenuEventHandler ShowGridMenu

VB.NET

Public Event ShowGridMenu As GridMenuEventHandler

Event Data

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

Property	Description
Customizations	Provides access to a collection of customizations of the grid menu, customized using this event handler.
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
Items	Gets the menu items contained within the context menu.
MenuInfo	Gets information about the context menu.
MenuType	Gets the context menu’s type.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source	Gets the View that raised the event.
TargetElement	Gets the UI element for which the context menu is shown.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

There are four types of context menus that enable an end-user to manage data (apply grouping and sorting, display summaries, etc.) and customize a View by showing and hiding its UI elements. All these menus can be customized. For example, you can remove existing menu items and/or add new items. This can be done in either XAML or at runtime, by handling the ShowGridMenu event.

For information on how context menus can be customized in XAML, see Context Menus.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ShowGridMenu 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-add-a-custom-button-to-a-column-header-e1838/CS/Window1.xaml#L14

<dxg:GridControl.View>
    <dxg:TableView Name="view" ShowGridMenu="TableView_ShowGridMenu">
        <dxg:TableView.ColumnHeaderCustomizationAreaTemplate>

how-to-modify-the-context-menu-of-grid-columns-e1837/CS/Window1.xaml#L10

<dxg:GridControl.View>
    <dxg:TableView ShowGridMenu="TableView_ShowGridMenu" />
</dxg:GridControl.View>

gridcontrol-how-to-rename-column-headers-at-runtime-e4187/CS/T686902/EditableColumnHeaderBehavior.cs#L32

    View.ColumnHeaderTemplate = (DataTemplate)Grid.FindResource("EditableHeaderTemplate");
    View.ShowGridMenu += View_ShowGridMenu;
}

VB.NET

gridcontrol-how-to-rename-column-headers-at-runtime-e4187/VB/T686902/EditableColumnHeaderBehavior.vb#L43

    View.ColumnHeaderTemplate = CType(Grid.FindResource("EditableHeaderTemplate"), DataTemplate)
    AddHandler View.ShowGridMenu, AddressOf View_ShowGridMenu
End Sub