.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

PivotCalculatedItemCollection.Add(String, String) Method

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

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v20.2.Core.dll

Declaration

PivotItem Add(
    string formula,
    string name
)
Function Add(
    formula As String,
    name As String
) As PivotItem

Parameters

Name Type Description
formula String

A String value that specifies the formula for the item.

name String

A String value that specifies the name of 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. A calculated item uses a formula to calculate its value based on values of other items in the same field where the calculated item resides.

The following code demonstrates how to create two calculated items to calculate total sales for each region.

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")

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

See Also