GridMenuItemClickEventArgs.DXMenuItem Property

Gets the clicked menu item.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

public DXMenuItem DXMenuItem { get; }
Public ReadOnly Property DXMenuItem As DXMenuItem

Property Value

Type Description
DXMenuItem

A DXMenuItem object representing the clicked menu item.

Remarks

The DXMenuItem property allows you to access the clicked menu item.

All menu items in Data Grid's built-in menus allow you to identify them by reading their DXMenuItem.Tag properties, which contain menu item identifiers.

The four tables below show the menu item identifiers (contents of the DXMenuItem.Tag properties) in Data Grid's built-in menus.

Column Header Menu (DevExpress.XtraGrid.Menu.GridViewColumnMenu)

VisualElems_GridView_ColumnHeaderContextMenu

When handling the PopupMenuShowing and GridMenuItemClick events, you can identify this menu type using the e.MenuType event parameter, which is set to GridMenuType.Column

The Tag properties of the items in this menu can be the following objects:

  • DevExpress.XtraGrid.Localization.GridStringId

  • DevExpress.XtraEditors.Controls.StringId

  • GridGroupSummaryItem

  • DevExpress.XtraGrid.ColumnGroupInterval

Menu Item

Tag

Full Expand

DevExpress.XtraGrid.Localization.GridStringId.MenuGroupPanelFullExpand

Full Collapse

DevExpress.XtraGrid.Localization.GridStringId.MenuGroupPanelFullCollapse

Sort Ascending

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnSortAscending

Sort Descending

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnSortDescending

Sort by Summary (sub-menu)

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnSortGroupBySummaryMenu

The Tag properties of this submenu's items contain GridGroupSummaryItem objects, which identify corresponding summary functions.

Group By This Column

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnGroup

UnGroup

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnUnGroup

Hide Group By Box

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnGroupBox

Show Group By Box

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnGroupBox

Split

DevExpress.XtraGrid.Localization.GridStringId.MenuShowSplitItem

Remove Split

DevExpress.XtraGrid.Localization.GridStringId.MenuHideSplitItem

Group Interval (sub-menu)

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnGroupIntervalMenu

    Day

    DevExpress.XtraGrid.ColumnGroupInterval.Default

    Month

    DevExpress.XtraGrid.ColumnGroupInterval.DateMonth

    Year

    DevExpress.XtraGrid.ColumnGroupInterval.DateYear

    Smart

    DevExpress.XtraGrid.ColumnGroupInterval.DateRange

Group Summary Editor...

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnGroupSummaryEditor

Hide This Column

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnRemoveColumn

Column Chooser

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnColumnCustomization

Best Fit

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnBestFit

Best Fit (all columns)

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnBestFitAllColumns

Filter Editor...

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnFilterEditor

Show Find Panel

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnFindFilterShow

Hide Find Panel

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnFindFilterHide

Show Auto Filter Row

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnAutoFilterRowShow

Hide Auto Filter Row

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnAutoFilterRowHide

Conditional Formatting (sub-menu)

DevExpress.XtraGrid.Localization.GridStringId.MenuColumnConditionalFormatting

    Highlight Cell Rules (sub-menu)

    DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemHighlightCellRules

        Greater Than...

        DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemGreaterThan

        Less Than...

        DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemLessThan

        Between...

        DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemBetween

        Equal To...

        DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemEqualTo

        Text that Contains...

        DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemTextThatContains

        A Date Occurring...

        DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemDateOccurring

        Custom Condition...

        DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemCustomCondition

    Top/Bottom Rules (sub-menu)

    DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemTopBottomRules

        Top 10 Items...

        DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemTop10Items

        Bottom 10 Items...

        DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemBottom10Items

    Unique/Duplicate Rules (sub-menu)

    DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemUniqueDuplicateRules

        Unique Values...

        DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemUnique

        Duplicate Values...

        DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemDuplicate

    Manage Rules...

    DevExpress.XtraEditors.Controls.StringId.FormatRuleMenuItemManageRules

Show Footer

DevExpress.XtraGrid.Localization.GridStringId.MenuFooterShow

Hide Footer

DevExpress.XtraGrid.Localization.GridStringId.MenuFooterHide

Group Panel Menu (DevExpress.XtraGrid.Menu.GridViewGroupPanelMenu)

GroupPanel - Context menu1

When handling the PopupMenuShowing and GridMenuItemClick events, you can identify this menu type using the e.MenuType event parameter, which is set to GridMenuType.Group

The Tag properties of the items in this menu contain DevExpress.XtraGrid.Localization.GridStringId enumeration values.

Menu Item Tag
Full Expand DevExpress.XtraGrid.Localization.GridStringId.MenuGroupPanelFullExpand
Full Collapse DevExpress.XtraGrid.Localization.GridStringId.MenuGroupPanelFullCollapse
Clear Grouping DevExpress.XtraGrid.Localization.GridStringId.MenuGroupPanelClearGrouping
Hide Group By Box DevExpress.XtraGrid.Localization.GridStringId.MenuColumnGroupBox
Split DevExpress.XtraGrid.Localization.GridStringId.MenuShowSplitItem
Remove Split DevExpress.XtraGrid.Localization.GridStringId.MenuHideSplitItem

Summary Menu (DevExpress.XtraGrid.Menu.GridViewFooterMenu)

VisualElems_GridView_FooterContextMenu

When handling the PopupMenuShowing and GridMenuItemClick events, you can identify this menu type using the e.MenuType event parameter, which is set to GridMenuType.Summary

The Tag properties of the items in this menu contain DevExpress.XtraGrid.Localization.GridStringId enumeration values.

Menu Item Tag
Add New Summary (sub-menu) DevExpress.XtraGrid.Localization.GridStringId.MenuFooterAddSummaryItem
Sum DevExpress.XtraGrid.Localization.GridStringId.MenuFooterSum
Min DevExpress.XtraGrid.Localization.GridStringId.MenuFooterMin
Max DevExpress.XtraGrid.Localization.GridStringId.MenuFooterMax
Count DevExpress.XtraGrid.Localization.GridStringId.MenuFooterCount
Average DevExpress.XtraGrid.Localization.GridStringId.MenuFooterAverage
None DevExpress.XtraGrid.Localization.GridStringId.MenuFooterNone
Clear Summary Items DevExpress.XtraGrid.Localization.GridStringId.MenuFooterClearSummaryItems

Auto Filter Row Menu

grid-autofiltermenu.png

When handling the PopupMenuShowing and GridMenuItemClick events, you can identify this menu type using the e.MenuType event parameter, which is set to GridMenuType.AutoFilter.

The Tag properties of the items in this menu contain DevExpress.XtraEditors.ColumnAutoFilterCondition enumeration values.

Menu Item Tag
Clear Filter null
Equals DevExpress.XtraEditors.ColumnAutoFilterCondition.Equals
Does not equal DevExpress.XtraEditors.ColumnAutoFilterCondition.DoesNotEqual
Contains DevExpress.XtraEditors.ColumnAutoFilterCondition.Contains
Does not contain DevExpress.XtraEditors.ColumnAutoFilterCondition.DoesNotContain
Is like DevExpress.XtraEditors.ColumnAutoFilterCondition.Like
Is not like DevExpress.XtraEditors.ColumnAutoFilterCondition.NotLike
Begins with DevExpress.XtraEditors.ColumnAutoFilterCondition.BeginsWith
Ends with DevExpress.XtraEditors.ColumnAutoFilterCondition.EndsWith
Is greater than DevExpress.XtraEditors.ColumnAutoFilterCondition.Greater
Is greater than or equal to DevExpress.XtraEditors.ColumnAutoFilterCondition.GreaterOrEqual
Is less than DevExpress.XtraEditors.ColumnAutoFilterCondition.Less
Is less than or equal to DevExpress.XtraEditors.ColumnAutoFilterCondition.LessOrEqual
See Also