alexa
menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Search Results for

    Show / Hide Table of Contents

    Interface IPivotFields

    Represents a collection of IPivotField in the pivot table.

    Inherited Members
    IEnumerable.GetEnumerator()
    Namespace: Syncfusion.XlsIO
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    public interface IPivotFields : IEnumerable

    Properties

    Count

    Gets the number of pivot fields in the pivot table.

    Declaration
    int Count { get; }
    Property Value
    Type
    int
    Remarks

    To know more about Pivot Tables refer this link.

    Examples

    Following code snippet illustrates how to use a Count property of the pivot field.

    using (ExcelEngine excelEngine = new ExcelEngine())
    {
      //Create a worksheet.        
      IApplication application = excelEngine.Excel;
      application.DefaultVersion = ExcelVersion.Excel2013;
      IWorkbook workbook = application.Workbooks.Open("SamplePivot.xlsx");
      IWorksheet sheet = workbook.Worksheets[0];
      IWorksheet pivotSheet = workbook.Worksheets[1];
    
      //Gets the number of pivot fields in the pivot table
      int pivotFieldCount = pivotSheet.PivotTables[0].Fields.Count;
      if(pivotFieldCount > 0)
      {
          //Your Code Here
      }
    
      workbook.SaveAs("PivotTables.xlsx");
      workbook.Close();
    }

    this[int]

    Gets the IPivotField from the collection with the specified index. Read-only.

    Declaration
    IPivotField this[int index] { get; }
    Parameters
    Type Name Description
    int index

    Item index to return.

    Property Value
    Type
    IPivotField
    Remarks

    To know more about Pivot Tables refer this link.

    Examples

    Following code snippet illustrates how to use a index property in pivot field collections.

    using (ExcelEngine excelEngine = new ExcelEngine())
    {
      //Create a worksheet.        
      IApplication application = excelEngine.Excel;
      application.DefaultVersion = ExcelVersion.Excel2013;
      IWorkbook workbook = application.Workbooks.Create(2);
      IWorksheet sheet = workbook.Worksheets[0];
      IWorksheet pivotSheet = workbook.Worksheets[1];
      sheet.Range["A1"].Text = "Student ID";
      sheet.Range["B1"].Text = "Student Name";
      sheet.Range["C1"].Text = "Mark(Out of 100)";
      sheet.Range["D1"].Text = "Student City";
      sheet.Range["A1:D1"].AutofitColumns();
      sheet.Range["A2"].Number = 1;
      sheet.Range["A3"].Number = 2;
      sheet.Range["A4"].Number = 3;
      sheet.Range["A5"].Number = 4;
      sheet.Range["A6"].Number = 5;
      sheet.Range["B2"].Text = "Andrew";
      sheet.Range["B3"].Text = "Marson";
      sheet.Range["B4"].Text = "Jack";
      sheet.Range["B5"].Text = "Sam";
      sheet.Range["B6"].Text = "Breto";
      sheet.Range["C2"].Number = 77;
      sheet.Range["C3"].Number = 45;
      sheet.Range["C4"].Number = 92;
      sheet.Range["C5"].Number = 39;
      sheet.Range["C6"].Number = 55;
      sheet.Range["D2"].Text = "Chennai";
      sheet.Range["D3"].Text = "Bangalore";
      sheet.Range["D4"].Text = "Chennai";
      sheet.Range["D5"].Text = "Mysore";
      sheet.Range["D6"].Text = "Bangalore";
      IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]);
      IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache);
    
      //Gets the pivot field from the collection with the specified index
      IPivotField pivotField = pivotTable.Fields[2];
      pivotField.NumberFormat = "#,##0_);(#,##0)";
      pivotTable.Fields[1].Axis = PivotAxisTypes.Row;
      pivotTable.Fields[3].Axis = PivotAxisTypes.Column;
    
      IPivotField datafield = pivotTable.Fields[2];
      pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum);
      pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20;
      workbook.SaveAs("PivotTables.xlsx");
      workbook.Close();
    }

    this[string]

    Gets the IPivotField from the collection with the specified name. Read-only.

    Declaration
    IPivotField this[string name] { get; }
    Parameters
    Type Name Description
    string name

    Name of the item to return.

    Property Value
    Type
    IPivotField
    Remarks

    To know more about Pivot Tables refer this link.

    Examples

    Following code snippet illustrates how to use a name as index in pivot field collections.

    using (ExcelEngine excelEngine = new ExcelEngine())
    {
      //Create a worksheet.        
      IApplication application = excelEngine.Excel;
      application.DefaultVersion = ExcelVersion.Excel2013;
      IWorkbook workbook = application.Workbooks.Create(2);
      IWorksheet sheet = workbook.Worksheets[0];
      IWorksheet pivotSheet = workbook.Worksheets[1];
      sheet.Range["A1"].Text = "Student ID";
      sheet.Range["B1"].Text = "Student Name";
      sheet.Range["C1"].Text = "Mark(Out of 100)";
      sheet.Range["D1"].Text = "Student City";
      sheet.Range["A1:D1"].AutofitColumns();
      sheet.Range["A2"].Number = 1;
      sheet.Range["A3"].Number = 2;
      sheet.Range["A4"].Number = 3;
      sheet.Range["A5"].Number = 4;
      sheet.Range["A6"].Number = 5;
      sheet.Range["B2"].Text = "Andrew";
      sheet.Range["B3"].Text = "Marson";
      sheet.Range["B4"].Text = "Jack";
      sheet.Range["B5"].Text = "Sam";
      sheet.Range["B6"].Text = "Breto";
      sheet.Range["C2"].Number = 77;
      sheet.Range["C3"].Number = 45;
      sheet.Range["C4"].Number = 92;
      sheet.Range["C5"].Number = 39;
      sheet.Range["C6"].Number = 55;
      sheet.Range["D2"].Text = "Chennai";
      sheet.Range["D3"].Text = "Bangalore";
      sheet.Range["D4"].Text = "Chennai";
      sheet.Range["D5"].Text = "Mysore";
      sheet.Range["D6"].Text = "Bangalore";
      IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]);
      IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache);
    
      //Gets the pivot field from the collection with the specified name
      IPivotField pivotField = pivotSheet.PivotTables[0].Fields["Mark(Out of 100)"];
      pivotField.NumberFormat = "#,##0_);(#,##0)";
      pivotTable.Fields["Student Name"].Axis = PivotAxisTypes.Row;
      pivotTable.Fields["Student City"].Axis = PivotAxisTypes.Column;
    
      IPivotField datafield = pivotTable.Fields[2];
      pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum);
      pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20;
      workbook.SaveAs("PivotTables.xlsx");
      workbook.Close();
    }
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved