PivotGridField Class

Represents a pivot grid field.

Assembly: DevExpress.Xpf.PivotGrid.v19.1.dll

Declaration

C#
VB.NET

public class PivotGridField :
    DXFrameworkContentElement,
    ILogicalOwner,
    IInputElement,
    IThreadSafeField

Public Class PivotGridField
    Inherits DXFrameworkContentElement
    Implements ILogicalOwner,
               IInputElement,
               IThreadSafeField

The following members return PivotGridField objects:

Show 40 links

Remarks

Pivot grid fields represent data source fields. Fields are visually represented by field headers, which can be moved between the pivot grid’s areas using drag-and-drop. Dragging fields between areas modifies the report’s layout.

The collection of fields can be accessed via the PivotGridControl.Fields property. Individual fields are represented by the PivotGridField class and can be accessed using indexed notation.

To learn more on pivot grid fields, see:

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:

A typed dataset is created from the database at design time.
Instances of SalesPersonDataTable and SalesPersonTableAdapter objects are created.
The PivotGridControl is bound to the SalesPersonDataTable instance via the PivotGridControl.DataSource property.
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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-bind-a-pivotgrid-to-an-ms-access-database-e2121.

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

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);
        }
    }
}

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

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

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.

how-to-customize-the-appearance-of-cells-e2517/CS/CustomAppearance/MainWindow.xaml#L12

<dxpg:PivotGridControl.Fields>
    <dxpg:PivotGridField Name="fieldCategoryName" FieldName="CategoryName" Area="RowArea"
                         Caption="Product Category" />

wpf-pivotgrid-customize-filter-editor/CS/WpfPivotCustomizeFilterEditorExample/WpfPivotCustomizeFilterEditorExample/MainWindow.xaml#L51

<dxpg:PivotGridControl.Fields>
    <dxpg:PivotGridField
        Area="DataArea"

wpf-pivotgrid-customize-filter-drop-down/CS/WpfPivotCustomFilterDropDownExample/MainWindow.xaml#L47

<dxpg:PivotGridControl.Fields>
    <dxpg:PivotGridField
        Area="DataArea"

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

<dxpg:PivotGridControl.Fields>
    <dxpg:PivotGridField Name="fieldCountry" FieldName="Country" Area="RowArea" />
    <dxpg:PivotGridField Name="fieldCustomer" FieldName="Sales Person" Area="RowArea" Caption="Customer" />

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

<dxpg:PivotGridControl.Fields>
    <dxpg:PivotGridField Name="fieldCountry" FieldName="Country" Area="RowArea" />
    <dxpg:PivotGridField Name="fieldCustomer" FieldName="Sales Person" Area="RowArea"