PivotGridField.Area Property

Gets or sets the area in which the field is displayed. This is a dependency property.

Namespace: DevExpress.Xpf.PivotGrid

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

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

Declaration

C#

public FieldArea Area { get; set; }

VB.NET

Public Property Area As FieldArea

Property Value

Type	Description
FieldArea	A FieldArea value that specifies the area in which the field is displayed.

Available values:

Name	Description
RowArea	Corresponds to the row header area.
ColumnArea	Corresponds to the column header area.
FilterArea	Corresponds to the filter header area.
DataArea	Corresponds to the data header area.

Remarks

A field can be placed in one of four areas: Filter Header Area, Column Header Area, Row Header Area or Data Header Area. The Area property specifies the area in which the field is displayed. The field can also be positioned using the PivotGridField.SetAreaPosition method. To get the field’s position among the other fields within the same area, use the PivotGridField.AreaIndex property.

The PivotGridField.AllowedAreas property specifies in which areas the field can be located. To obtain whether the field can be displayed in a particular area, use the PivotGridField.IsAreaAllowed property.

Dragging a field from one area to another automatically changes the Area property value, and vice versa. Before the field location is changed, PivotGridControl fires the PivotGridControl.FieldAreaChanging event, allowing you to cancel the action. After the location has been changed, the PivotGridControl.FieldAreaChanged event is fired.

Multiple fields can be combined into a group via the PivotGridControl.Groups property. These fields cannot be separated and are always dragged together. To move a group to a specific area or to a new position within the current area, use the Area and PivotGridField.AreaIndex properties of the first field in the group. Modifying the Area and AreaIndex properties for the second and subsequent fields in the group is ignored.

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 Area 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-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#L52

<dxpg:PivotGridField
    Area="DataArea"
    Caption="Product Sales"

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

<dxpg:PivotGridField
    Area="DataArea"
    Caption="Product Sales"

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

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

C#

how-to-lock-pivot-grid-updates-e2724/CS/DXPivotGrid_BeginEndUpdate/MainWindow.xaml.cs#L38

foreach (PivotGridField field in pivotGridControl1.Fields) {
    if (field.Area == FieldArea.RowArea)
        field.Area = FieldArea.ColumnArea;

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

{
    if (field.Visible == false || field.Area == FieldArea.DataArea || field.Area == FieldArea.FilterArea) continue;
    visibleValues[field] = new  List<object>(field.GetVisibleValues());

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

PivotGridField fieldYear = pivotGridControl1.Fields["OrderDate"];
fieldYear.Area = FieldArea.ColumnArea;
fieldYear.GroupInterval = FieldGroupInterval.DateYear;

VB.NET

how-to-lock-pivot-grid-updates-e2724/VB/DXPivotGrid_BeginEndUpdate/MainWindow.xaml.vb#L42

For Each field As PivotGridField In pivotGridControl1.Fields
    If field.Area = FieldArea.RowArea Then
        field.Area = FieldArea.ColumnArea

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

For Each field As PivotGridField In pivot.Fields
    If field.Visible = False OrElse field.Area = FieldArea.DataArea OrElse field.Area = FieldArea.FilterArea Then
        Continue For

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

Dim fieldYear As PivotGridField = pivotGridControl1.Fields("OrderDate")
fieldYear.Area = FieldArea.ColumnArea
fieldYear.GroupInterval = FieldGroupInterval.DateYear