DataViewBase.ColumnMenuCustomizations Property

Allows you to customize the column header‘s context menu. You can add new menu items or remove existing items.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v20.2.Core.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Grid.Core, DevExpress.Wpf.Grid.Core

Declaration

C#

[Browsable(false)]
public BarManagerActionCollection ColumnMenuCustomizations { get; }

VB.NET

<Browsable(False)>
Public ReadOnly Property ColumnMenuCustomizations As BarManagerActionCollection

Property Value

Type	Description
BarManagerActionCollection	A collection of bar actions to customize the column header‘s context menu.

Remarks

Example

The following example demonstrates how to add a custom menu item to a grid column’s context menu:

View Example

In XAML

Add a bar item (for example, BarCheckItem) to the DataViewBase.ColumnMenuCustomizations collection and specify item properties. Attach the BarItemLinkActionBase.ItemLinkIndex property to this item to insert it into a specific position.

Window1.xaml

<dxg:TableView.ColumnMenuCustomizations>
    <dxb:BarCheckItem Name="checkItem1" Content="Checked" IsChecked="True" dxb:BarItemLinkActionBase.ItemLinkIndex="0" />
    <dxb:BarItemLinkSeparator dxb:BarItemLinkActionBase.ItemLinkIndex="1" />
</dxg:TableView.ColumnMenuCustomizations>

Window1.xaml.cs

private void customItem1_CheckedChanged(object sender, ItemClickEventArgs e) {
    // do something...
}

Window1.xaml.vb

Private Sub customItem1_CheckedChanged(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    ' do something...
End Sub

In Code

Handle the ShowGridMenu event.

MainWindow.xaml

<dxg:TableView ShowGridMenu="ShowGridMenu" />

MainWindow.xaml.cs

void ShowGridMenu(object sender, GridMenuEventArgs e) {
    if (e.MenuType == GridMenuType.Column) {
        BarCheckItem item1 = new BarCheckItem { Content = "Checked", IsChecked = true };
        BarItemLinkActionBase.SetItemLinkIndex(item1, 0);
        e.Customizations.Add(item1);
        BarItemLinkSeparator item2 = new BarItemLinkSeparator();
        BarItemLinkActionBase.SetItemLinkIndex(item2, 1);
        e.Customizations.Add(item2);
    }
}

MainWindow.xaml.vb

Sub ShowGridMenu(sender As Object, e As GridMenuEventArgs)
    If e.MenuType = GridMenuType.Column Then
        Dim item1 As BarCheckItem = New BarCheckItem() With {.Content = "Checked", .IsChecked = True}
        BarItemLinkActionBase.SetItemLinkIndex(item1, 0)
        e.Customizations.Add(item1)
        Dim item2 As BarItemLinkSeparator = New BarItemLinkSeparator()
        BarItemLinkActionBase.SetItemLinkIndex(item2, 1)
        e.Customizations.Add(item2)
    End If
End Sub

Refer to the Context Menus topic for more information.