PivotCalculatedItemCollection.Add(String) Method

Creates a new calculated item and appends it to the collection.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

PivotItem Add(
    string formula
)

VB.NET

Function Add(
    formula As String
) As PivotItem

Parameters

Name	Type	Description
formula	String	A String value that specifies the formula for the item.

Returns

Type	Description
PivotItem	A PivotItem object that specifies the newly created calculated item.

Remarks

Use the Add method to add a calculated item to a PivotTable field. The default name (Formula1, Formula2, etc.) will be automatically assigned to the calculated item. To rename the item, use the PivotItem.Caption property.

For more information on how to insert and modify calculated items, refer to the How to: Create a Calculated Item example.

Example

View Example

PivotCalculatedItemActions.cs

Worksheet worksheet = workbook.Worksheets["Report10"];
workbook.Worksheets.ActiveWorksheet = worksheet;

// Access the pivot table by its name in the collection.
PivotTable pivotTable = worksheet.PivotTables["PivotTable1"];

// Access the pivot field by its name in the collection.
PivotField field = pivotTable.Fields["State"];

// Add calculated items to the "State" field.
field.CalculatedItems.Add("=Arizona+California+Colorado", "West Total");
field.CalculatedItems.Add("=Illinois+Kansas+Wisconsin", "Midwest Total");

PivotCalculatedItemActions.vb

Dim worksheet As Worksheet = workbook.Worksheets("Report10")
workbook.Worksheets.ActiveWorksheet = worksheet

' Access the pivot table by its name in the collection.
Dim pivotTable As PivotTable = worksheet.PivotTables("PivotTable1")

' Access the pivot field by its name in the collection.
Dim field As PivotField = pivotTable.Fields("State")

' Add calculated items to the "State" field.
field.CalculatedItems.Add("=Arizona+California+Colorado", "West Total")
field.CalculatedItems.Add("=Illinois+Kansas+Wisconsin", "Midwest Total")