PivotFieldGroupingActions.cs

using DevExpress.Spreadsheet;
using System;
using System.Collections.Generic;

namespace SpreadsheetDocServerPivotAPI
{
    class PivotFieldGroupingActions
    {
        public static Action<Workbook> GroupFieldItemsAction = GroupFieldItems;
        public static Action<Workbook> GroupFieldByDatesAction = GroupFieldByDates;
        public static Action<Workbook> UngroupSpecificItemAction = UngroupSpecificItem;
        public static Action<Workbook> UngroupFieldItemsAction = UngroupFieldItems;

        static void GroupFieldItems(IWorkbook workbook)
        {
            #region #GroupFieldItems
            Worksheet worksheet = workbook.Worksheets["Report11"];
            workbook.Worksheets.ActiveWorksheet = worksheet;

            // Access the pivot table by its name in the collection.
            PivotTable pivotTable = worksheet.PivotTables["PivotTable1"];
            // Access the "State" field by its name in the collection.
            PivotField field = pivotTable.Fields["State"];
            // Add the "State" field to the column axis area.
            pivotTable.ColumnFields.Add(field);

            // Group the first three items in the field.
            IEnumerable<int> items = new List<int>() { 0, 1, 2 };
            field.GroupItems(items);
            // Access the created grouped field by its index in the field collection.
            int groupedFieldIndex = pivotTable.Fields.Count - 1;
            PivotField groupedField = pivotTable.Fields[groupedFieldIndex];
            // Set the grouped item caption to "West".
            groupedField.Items[0].Caption = "West";
            #endregion #GroupFieldItems
        }

        static void GroupFieldByDates(IWorkbook workbook)
        {
            #region #GroupFieldByDates
            Worksheet worksheet = workbook.Worksheets["Report8"];
            workbook.Worksheets.ActiveWorksheet = worksheet;

            // Access the pivot table by its name in the collection.
            PivotTable pivotTable = worksheet.PivotTables["PivotTable1"];
            // Access the "DATE" field by its name in the collection.
            PivotField field = pivotTable.Fields["DATE"];
            // Group field items by quarters and months.
            field.GroupItems(PivotFieldGroupByType.Quarters | PivotFieldGroupByType.Months);
            #endregion #GroupFieldByDates
        }

        static void GroupFieldByNumericRanges(IWorkbook workbook)
        {
            #region #GroupFieldByNumericRanges
            Worksheet worksheet = workbook.Worksheets["Report12"];
            workbook.Worksheets.ActiveWorksheet = worksheet;

            // Access the pivot table by its name in the collection.
            PivotTable pivotTable = worksheet.PivotTables["PivotTable1"];
            // Access the "Usual Hours Worked" field by its name in the collection.
            PivotField field = pivotTable.Fields["Sales"];
            // Group field items from 1000 to 4000 by 1000.
            field.GroupItems(1000, 4000, 1000, PivotFieldGroupByType.NumericRanges);
            #endregion #GroupFieldByNumericRanges
        }

        static void UngroupSpecificItem(IWorkbook workbook)
        {
            #region #UngroupSpecificItem
            Worksheet worksheet = workbook.Worksheets["Report11"];
            workbook.Worksheets.ActiveWorksheet = worksheet;

            // Access the pivot table by its name in the collection
            PivotTable pivotTable = worksheet.PivotTables["PivotTable1"];
            // Access the "State" field by its name in the collection.
            PivotField field = pivotTable.Fields["State"];
            // Add the "State" field to the column axis area.
            pivotTable.ColumnFields.Add(field);

            // Group the first three items in the field.
            IEnumerable<int> items = new List<int>() { 0, 1, 2 };
            field.GroupItems(items);
            // Access the created grouped field by its index in the field collection.
            int groupedFieldIndex = pivotTable.Fields.Count - 1;
            PivotField groupedField = pivotTable.Fields[groupedFieldIndex];
            // Set the grouped item caption to "West".
            groupedField.Items[0].Caption = "West";

            // Group the remaining field items.
            items = new List<int>() { 3, 4, 5 };
            field.GroupItems(items);
            // Set the grouped item caption to "Midwest"
            groupedField.Items[1].Caption = "Midwest";

            // Ungroup the "West" item.
            items = new List<int> { 0 };
            groupedField.UngroupItems(items);
            #endregion #UngroupSpecificItem
        }

        static void UngroupFieldItems(IWorkbook workbook)
        {
            #region #UngroupFieldItems
            Worksheet worksheet = workbook.Worksheets["Report8"];
            workbook.Worksheets.ActiveWorksheet = worksheet;

            // Access the pivot table by its name in the collection.
            PivotTable pivotTable = worksheet.PivotTables["PivotTable1"];
            // Access the "DATE" field by its name in the collection.
            PivotField field = pivotTable.Fields["DATE"];
            // Group field items by days.
            field.GroupItems(field.GroupingInfo.DefaultStartValue, field.GroupingInfo.DefaultEndValue, 50, PivotFieldGroupByType.Days);
            // Ungroup field items.
            field.UngroupItems();
            #endregion #UngroupFieldItems
        }
    }
}