PivotGridControl.Fields Property

Provides access to a pivot grid’s field collection.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.PivotGrid, DevExpress.Wpf.PivotGrid

Declaration

C#

public PivotGridFieldCollection Fields { get; }

VB.NET

Public ReadOnly Property Fields As PivotGridFieldCollection

Property Value

Type	Description
PivotGridFieldCollection	A PivotGridFieldCollection object which represents a collection of all the fields within a pivot grid.

Remarks

The Fields collection stores all the fields contained in the PivotGridControl. It provides methods allowing you to access, add and delete fields. Individual fields can be accessed using indexed notation.

To learn more, see Fields.

Example

The following example demonstrates how to bind the PivotGridControl to a “SalesPerson” view in the nwind.mdb database, which is shipped with the installation. The control will be used to analyse sales per country, customers, product categories and years.

The following steps were used to created this example:

1. A typed dataset is created from the database at design time.
2. Instances of SalesPersonDataTable and SalesPersonTableAdapter objects are created.
3. The PivotGridControl is bound to the SalesPersonDataTable instance via the PivotGridControl.DataSource property.
4. The table is filled with data in the Window_Loaded event handler.

The pivot grid fields that will represent data source fields are created in XAML markup. They are positioned within appropriate areas to analyze the data in the way you want.

Note that if you want to see an example of how to programmatically add pivot grid fields, please refer to the How to: Bind a PivotGrid to an MS Access Database Programmatically tutorial.

View Example

MainWindow.xaml

<Window x:Class="HowToBindToMDB.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxpg="http://schemas.devexpress.com/winfx/2008/xaml/pivotgrid"
        Title="MainWindow" Height="350" Width="525"  Loaded="Window_Loaded">
    <Grid>
        <dxpg:PivotGridControl HorizontalAlignment="Left" Name="pivotGridControl1"
                               VerticalAlignment="Top">
            <dxpg:PivotGridControl.Fields>
                <dxpg:PivotGridField Name="fieldCountry" FieldName="Country" Area="RowArea" />
                <dxpg:PivotGridField Name="fieldCustomer" FieldName="Sales Person" Area="RowArea"
                                     Caption="Customer" />
                <dxpg:PivotGridField Name="fieldYear" FieldName="OrderDate" Area="ColumnArea"
                                     Caption="Year" GroupInterval="DateYear" />
                <dxpg:PivotGridField Name="fieldCategoryName" FieldName="CategoryName" 
                                     Area="ColumnArea" Caption="Product Category" />
                <dxpg:PivotGridField Name="fieldProductName" FieldName="ProductName" 
                                     Area="FilterArea" Caption="Product Name" />
                <dxpg:PivotGridField Name="fieldExtendedPrice" FieldName="Extended Price" 
                                     Area="DataArea" CellFormat="c0" />
            </dxpg:PivotGridControl.Fields>
        </dxpg:PivotGridControl>
    </Grid>
</Window>

MainWindow.xaml.cs

using System.Data;
using System.Data.OleDb;
using System.Windows;
using DevExpress.Xpf.PivotGrid;
using HowToBindToMDB.NwindDataSetTableAdapters;

namespace HowToBindToMDB {
    public partial class MainWindow : Window {
        NwindDataSet.SalesPersonDataTable salesPersonDataTable = 
            new NwindDataSet.SalesPersonDataTable();
        SalesPersonTableAdapter salesPersonDataAdapter = new SalesPersonTableAdapter();

        public MainWindow() {
            InitializeComponent();
            pivotGridControl1.DataSource = salesPersonDataTable;
        }

        private void Window_Loaded(object sender, RoutedEventArgs e) {
            salesPersonDataAdapter.Fill(salesPersonDataTable);
        }
    }
}

MainWindow.xaml.vb

Imports Microsoft.VisualBasic
Imports System.Data
Imports System.Data.OleDb
Imports System.Windows
Imports DevExpress.Xpf.PivotGrid
Imports HowToBindToMDB.NwindDataSetTableAdapters

Namespace HowToBindToMDB
    Partial Public Class MainWindow
        Inherits Window
        Private salesPersonDataTable As New NwindDataSet.SalesPersonDataTable()
        Private salesPersonDataAdapter As New SalesPersonTableAdapter()

        Public Sub New()
            InitializeComponent()
            pivotGridControl1.DataSource = salesPersonDataTable
        End Sub

        Private Sub Window_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
            salesPersonDataAdapter.Fill(salesPersonDataTable)
        End Sub
    End Class
End Namespace

Related GitHub Examples

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

XAML

how-to-emulate-a-focused-row-e2486/CS/Q273921/MainWindow.xaml#L7

<dxpg:PivotGridControl Name="salesPersonPivot" SelectMode="MultiSelection" CellClick="salesPersonPivot_CellClick">
    <dxpg:PivotGridControl.Fields>
        <dxpg:PivotGridField FieldName="Sales Person" Area="RowArea" />

how-to-properly-refresh-data-for-controls-bound-to-the-pivotdrilldowndatasource-e2655/CS/Q292166/MainWindow.xaml#L15

<dxpg:PivotGridControl Name="salesPersonPivot" CellClick="OnSalesPersonPivotCellClick" Grid.Column="0" Grid.ColumnSpan="2" Grid.Row="0">
    <dxpg:PivotGridControl.Fields>
        <dxpg:PivotGridField FieldName="Sales Person" Area="RowArea" />

how-to-create-a-context-menu-for-header-area-e2233/CS/CreateValueContextMenu/MainWindow.xaml#L9

<dxpg:PivotGridControl HorizontalAlignment="Left" Name="pivotGridControl1" VerticalAlignment="Top">
    <dxpg:PivotGridControl.Fields>
        <dxpg:PivotGridField Name="fieldCountry" FieldName="Country" Area="RowArea" />

wpf-pivot-custom-group-intervals/CS/HowToCustomGroupInterval/MainWindow.xaml#L11

                   VerticalAlignment="Top">
<dxpg:PivotGridControl.Fields>
    <dxpg:PivotGridField Name="fieldProductGroup" FieldName="ProductName" Area="RowArea"

how-to-work-with-the-dxpivotgrid-control-offline-e2124/CS/HowToWorkOffline/MainWindow.xaml#L14

                   VerticalAlignment="Top" Margin="0,0,0,8">
<dxpg:PivotGridControl.Fields>
    <dxpg:PivotGridField Name="fieldCountry" FieldName="Country" Area="RowArea" />

C#

how-to-collapse-new-field-values-e3230/CS/WpfApplication52/MainWindow.xaml.cs#L76

PivotGridControl pivot =(PivotGridControl)sender;
foreach (PivotGridField field in pivot.Fields )
{

how-to-define-a-custom-cell-template-that-allows-performing-data-editing-t410760/CS/HowToEditCell/MainWindow.xaml.cs#L27

PivotGridControl pivotGrid = (PivotGridControl)sender;
PivotGridField fieldExtendedPrice = pivotGrid.Fields["ExtendedPrice"];
PivotDrillDownDataSource ds = args.CreateDrillDownDataSource();

how-to-create-a-custom-exporter-that-supports-autorowheight-bestfit-and-fittopage-t274241/CS/WpfApplication31/PivotReportGenerator.cs#L91

    if(pivot.Fields[i].Area == area)
        fields.Add(pivot.Fields[i]);
return fields;

VB.NET

how-to-collapse-new-field-values-e3230/VB/WpfApplication52/MainWindow.xaml.vb#L72

Dim pivot As PivotGridControl =CType(sender, PivotGridControl)
For Each field As PivotGridField In pivot.Fields
    If field.Visible = False OrElse field.Area = FieldArea.DataArea OrElse field.Area = FieldArea.FilterArea Then

how-to-define-a-custom-cell-template-that-allows-performing-data-editing-t410760/VB/HowToEditCell/MainWindow.xaml.vb#L28

Dim pivotGrid As PivotGridControl = CType(sender, PivotGridControl)
Dim fieldExtendedPrice As PivotGridField = pivotGrid.Fields("ExtendedPrice")
Dim ds As PivotDrillDownDataSource = args.CreateDrillDownDataSource()

how-to-create-a-custom-exporter-that-supports-autorowheight-bestfit-and-fittopage-t274241/VB/WpfApplication31/PivotReportGenerator.vb#L100

If pivot.Fields(i).Area = area Then
    fields.Add(pivot.Fields(i))
End If