Back to Devexpress

PivotTable.RowFields Property

officefileapi-devexpress-dot-spreadsheet-dot-pivottable-0cde83ca.md

latest8.3 KB
Original Source

PivotTable.RowFields Property

Provides access to the collection of fields located in the row axis area of the PivotTable report.

Namespace : DevExpress.Spreadsheet

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
PivotFieldReferenceCollection RowFields { get; }
vb
ReadOnly Property RowFields As PivotFieldReferenceCollection

Property Value

TypeDescription
PivotFieldReferenceCollection

A PivotFieldReferenceCollection object that represents the collection of row fields.

|

Remarks

Use the RowFields property to get access to the collection that stores all row fields added to the PivotTable report. An individual row field can be accessed by its index or name in the collection.

To add a new row field to the pivot table, use the PivotFieldReferenceCollection.Add method. To add a field to the row area at the specified position, use the PivotFieldReferenceCollection.Insert method.

To remove a row field from the PivotTable report, use the PivotFieldReferenceCollection.Remove or PivotFieldReferenceCollection.RemoveAt method. You can also use the PivotFieldReferenceCollection.Clear method to remove all fields from the PivotTable’s row area at once.

Example

View Example

vb
Dim sourceWorksheet As Worksheet = workbook.Worksheets("Data1")
Dim worksheet As Worksheet = workbook.Worksheets.Add()
workbook.Worksheets.ActiveWorksheet = worksheet

' Create a pivot table.
Dim pivotTable As PivotTable = worksheet.PivotTables.Add(sourceWorksheet("A1:D41"), worksheet("B2"))

' Add the "Product" field to the row axis area.
pivotTable.RowFields.Add(pivotTable.Fields("Product"))
' Add the "Category" field to the column axis area.
pivotTable.ColumnFields.Add(pivotTable.Fields("Category"))
' Add the "Sales" field to the data area and specify the custom field name.
Dim dataField As PivotDataField = pivotTable.DataFields.Add(pivotTable.Fields("Sales"), "Sales(Sum)")
' Specify the number format for the "Sales" field.
dataField.NumberFormat = "_([$$-409]* #,##0.00_);_([$$-409]* (#,##0.00);_([$$-409]* "" - ""??_);_(@_)"
' Add the "Region" field to the filter area.
pivotTable.PageFields.Add(pivotTable.Fields("Region"))
csharp
Worksheet sourceWorksheet = workbook.Worksheets["Data1"];
Worksheet worksheet = workbook.Worksheets.Add();
workbook.Worksheets.ActiveWorksheet = worksheet;

// Create a pivot table.
PivotTable pivotTable = worksheet.PivotTables.Add(sourceWorksheet["A1:D41"], worksheet["B2"]);

// Add the "Product" field to the row axis area.
pivotTable.RowFields.Add(pivotTable.Fields["Product"]);
// Add the "Category" field to the column axis area.
pivotTable.ColumnFields.Add(pivotTable.Fields["Category"]);
// Add the "Sales" field to the data area and specify the custom field name.
PivotDataField dataField = pivotTable.DataFields.Add(pivotTable.Fields["Sales"], "Sales(Sum)");
// Specify the number format for the "Sales" field.
dataField.NumberFormat = @"_([$$-409]* #,##0.00_);_([$$-409]* (#,##0.00);_([$$-409]* "" - ""??_);_(@_)";
// Add the "Region" field to the filter area.
pivotTable.PageFields.Add(pivotTable.Fields["Region"]);

The following code snippets (auto-collected from DevExpress Examples) contain references to the RowFields 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.

wpf-spreadsheet-pivot-table-api-examples/CS/SpreadsheetWPFPivotTableExamples/CodeExamples/PivotFieldActions.cs#L97

csharp
// Remove the "Product" field from the row axis area.
pivotTable.RowFields.Remove(pivotTable.RowFields["Product"]);
#endregion #RemoveFromAxis

winforms-spreadsheet-pivot-table-api/CS/SpreadsheetPivotTableExamples/CodeExamples/PivotFieldActions.cs#L96

csharp
// Remove the "Product" field from the row axis area.
pivotTable.RowFields.Remove(pivotTable.RowFields["Product"]);
#endregion #RemoveFromAxis

spreadsheet-document-api-pivot-table-examples/CS/SpreadsheetDocServerPivotAPI/CodeExamples/PivotFieldActions.cs#L108

csharp
// Remove the "Product" field from the row axis area.
pivotTable.RowFields.Remove(pivotTable.RowFields["Product"]);
#endregion #RemoveFromAxis

wpf-spreadsheet-pivot-table-api-examples/VB/SpreadsheetWPFPivotTableExamples/CodeExamples/PivotFieldActions.vb#L93

vb
' Remove the "Product" field from the row axis area.
            pivotTable.RowFields.Remove(pivotTable.RowFields("Product"))
' #End Region ' #RemoveFromAxis

winforms-spreadsheet-pivot-table-api/VB/SpreadsheetPivotTableExamples/CodeExamples/PivotFieldActions.vb#L92

vb
' Remove the "Product" field from the row axis area.
            pivotTable.RowFields.Remove(pivotTable.RowFields("Product"))
' #End Region ' #RemoveFromAxis

spreadsheet-document-api-pivot-table-examples/VB/SpreadsheetDocServerPivotAPI/CodeExamples/PivotFieldActions.vb#L100

vb
' Remove the "Product" field from the row axis area.
            pivotTable.RowFields.Remove(pivotTable.RowFields("Product"))
#End Region ' #RemoveFromAxis

See Also

Pivot Table API

How to: Create a Pivot Table

PivotTable Interface

PivotTable Members

DevExpress.Spreadsheet Namespace