PivotGridMenuType Enum

Lists values that specify the Pivot Grid Control’s context menu types.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v17.2.dll

Declaration

C#

public enum PivotGridMenuType

VB.NET

Public Enum PivotGridMenuType

Members

Name	Description
Header	Corresponds to the field header context menu.
HeaderArea	Corresponds to the header area context menu.
FieldValue	Corresponds to the field value context menu.
HeaderSummaries	Corresponds to the menu allowing an end-user to select a summary type for a data field (when the PivotGridFieldOptions.AllowRunTimeSummaryChange option is enabled).
Cell	Corresponds to the context menu, allowing end-users to apply conditional formatting to data cells (when the PivotGridOptionsMenu.EnableFormatRulesMenu option is enabled).

Related API Members

The following properties accept/return PivotGridMenuType values:

• PivotGridMenuEventArgsBase.MenuType

Remarks

The values listed by this enumeration are used to set the PivotGridMenuEventArgsBase.MenuType property which is exposed via the PivotGridControl.MenuItemClick event’s parameter.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PivotGridMenuType enum.

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-enable-users-to-design-pivotgridcontrol-format-conditions-at-runtime-t145142/CS/PivotGridFormatCondition/ViewFormatDesigner.cs#L28

{
    if (e.MenuType == PivotGridMenuType.FieldValue && e.HitInfo.ValueInfo != null)
    {

winforms-pivot-change-summarydisplaytype-in-context-menu/CS/WindowsApplication34/Form1.cs#L35

void pivotGridControl1_PopupMenuShowing(object sender, PopupMenuShowingEventArgs e) {
    if (e.MenuType == PivotGridMenuType.HeaderSummaries) {
        DXSubMenuItem sdtItem = new DXSubMenuItem();

how-to-implement-a-custom-sort-by-summary-feature-e2917/CS/WindowsApplication53/Form1.cs#L75

{
    if (! Equals( e.MenuType, PivotGridMenuType.FieldValue)) return;
    foreach (DXMenuItem item in e.Menu.Items)

how-to-implement-sorting-for-a-custom-cell-value-e2149/CS/ImplementSortingforaCustomCellValue/Form1.cs#L184

{
    if (e.MenuType == PivotGridMenuType.FieldValue)
        e.Allow = false;

winforms-pivot-totals-visibility/CS/Form1.cs#L20

void pivotGridControl1_PopupMenuShowing(object sender, DevExpress.XtraPivotGrid.PopupMenuShowingEventArgs e) {
    if(e.MenuType == DevExpress.XtraPivotGrid.PivotGridMenuType.Header) {
        HandleHeaderShowMenu(e);

VB.NET

how-to-enable-users-to-design-pivotgridcontrol-format-conditions-at-runtime-t145142/VB/PivotGridFormatCondition/ViewFormatDesigner.vb#L26

Private Sub PivotGridControl_PopupMenuShowing(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PopupMenuShowingEventArgs)
    If e.MenuType = PivotGridMenuType.FieldValue AndAlso e.HitInfo.ValueInfo IsNot Nothing Then
        e.Menu.Items.Add(CreateMenuItem(CreateCaptionForCondition(e.HitInfo.ValueInfo.DataField, True), "Simple"))

winforms-pivot-change-summarydisplaytype-in-context-menu/VB/WindowsApplication34/Form1.vb#L38

Private Sub pivotGridControl1_PopupMenuShowing(ByVal sender As Object, ByVal e As PopupMenuShowingEventArgs)
    If e.MenuType = PivotGridMenuType.HeaderSummaries Then

how-to-implement-a-custom-sort-by-summary-feature-e2917/VB/WindowsApplication53/Form1.vb#L68

Private Sub pivotGridControl1_PopupMenuShowing(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PopupMenuShowingEventArgs)
    If Not Equals(e.MenuType, PivotGridMenuType.FieldValue) Then
        Return

how-to-implement-sorting-for-a-custom-cell-value-e2149/VB/ImplementSortingforaCustomCellValue/Form1.vb#L188

Private Sub pivotGridControl1_PopupMenuShowing(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PopupMenuShowingEventArgs)
    If e.MenuType = PivotGridMenuType.FieldValue Then
        e.Allow = False

winforms-pivot-totals-visibility/VB/Form1.vb#L26

Private Sub pivotGridControl1_PopupMenuShowing(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PopupMenuShowingEventArgs) Handles pivotGridControl1.PopupMenuShowing
    If e.MenuType = DevExpress.XtraPivotGrid.PivotGridMenuType.Header Then
        HandleHeaderShowMenu(e)