PivotItem.Formula Property

Gets or sets the formula for the calculated item.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

string Formula { get; set; }

VB.NET

Property Formula As String

Property Value

Type	Description
String	A String value that is the calculated item’s formula.

Remarks

Use the Formula property to modify the formula of the existing calculated item. To add a calculated item to a specific field, use the PivotCalculatedItemCollection.Add method of the PivotField.CalculatedItems collection.

View Example

PivotCalculatedItemActions.cs

Worksheet worksheet = workbook.Worksheets["Report7"];
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["Customer"];

// Add a calculated item to the "Customer" field.
PivotItem item = field.CalculatedItems.Add("='Big Foods'*110%", "Big Foods Sales Plan");

//Change the formula for the calculated item.
item.Formula = "='Big Foods'*115%";

PivotCalculatedItemActions.vb

Dim worksheet As Worksheet = workbook.Worksheets("Report7")
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("Customer")

' Add a calculated item to the "Customer" field.
Dim item As PivotItem = field.CalculatedItems.Add("='Big Foods'*110%", "Big Foods Sales Plan")

'Change the formula for the calculated item.
item.Formula = "='Big Foods'*115%"

For the field items that originate from the source data, the Formula property returns an empty string.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Formula property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

spreadsheet-document-api-pivot-table-examples/CS/SpreadsheetDocServerPivotAPI/CodeExamples/PivotCalculatedItemActions.cs#L61

//Change the formula for the calculated item.
item.Formula = "='Big Foods'*115%";
#endregion #ModifyCalculatedItem

wpf-spreadsheet-pivot-table-api-examples/CS/SpreadsheetWPFPivotTableExamples/CodeExamples/PivotCalculatedItemActions.cs#L61

//Change the formula for the calculated item.
item.Formula = "='Big Foods'*115%";
#endregion #ModifyCalculatedItem

winforms-spreadsheet-pivot-table-api/CS/SpreadsheetPivotTableExamples/CodeExamples/PivotCalculatedItemActions.cs#L61

//Change the formula for the calculated item.
item.Formula = "='Big Foods'*115%";
#endregion #ModifyCalculatedItem

VB.NET

spreadsheet-document-api-pivot-table-examples/VB/SpreadsheetDocServerPivotAPI/CodeExamples/PivotCalculatedItemActions.vb#L56

            'Change the formula for the calculated item.
            item.Formula = "='Big Foods'*115%"
'            #End Region ' #ModifyCalculatedItem

wpf-spreadsheet-pivot-table-api-examples/VB/SpreadsheetWPFPivotTableExamples/CodeExamples/PivotCalculatedItemActions.vb#L56

            'Change the formula for the calculated item.
            item.Formula = "='Big Foods'*115%"
'            #End Region ' #ModifyCalculatedItem

winforms-spreadsheet-pivot-table-api/VB/SpreadsheetPivotTableExamples/CodeExamples/PivotCalculatedItemActions.vb#L56

            'Change the formula for the calculated item.
            item.Formula = "='Big Foods'*115%"
'            #End Region ' #ModifyCalculatedItem