alexa
menu

MAUI

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

    Show / Hide Table of Contents

    Interface IPivotFieldItem

    Represents an item in PivotTable field. The items are the individual data entries in a field category.

    Namespace: Syncfusion.XlsIO
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    public interface IPivotFieldItem

    Properties

    Position

    Gets or sets position of the field (first, second, third and so on).

    Declaration
    int Position { get; set; }
    Property Value
    Type
    int
    Remarks

    To know more about Pivot Tables refer this link.

    Examples

    The following code illustrates setting the position of Pivot field item.

    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);
      IPivotField pivotField = pivotTable.Fields[1];
    
      //Sets position of the field 
      pivotField.Items[0].Position = 2;
    
      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();
    }

    Text

    Gets or sets the text of the field item.

    Declaration
    string Text { get; set; }
    Property Value
    Type
    string
    Examples

    The following code illustrates setting the text of Pivot field item.

    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);
      IPivotField pivotField = pivotTable.Fields[1];
    
      //Sets the text of the field item.
      pivotField.Items[0].Text = "SampleText";
    
      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();
    }

    Visible

    Gets or sets a Boolean value indicating the visibility of pivot field item.

    Declaration
    bool Visible { get; set; }
    Property Value
    Type
    bool
    Remarks

    To know more about Pivot Tables refer this link.

    Examples

    Following code snippet illustrates how to use a Visible property in pivot field item.

    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);
      IPivotField pivotField = pivotTable.Fields[1];
    
      //Sets a Boolean value indicating the visibility of pivot field item.
      pivotField.Items[0].Visible = false;
    
      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();
    }
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved