PivotGridField.AreaIndex Property

Gets or sets the field’s index among the other fields displayed within the same area. 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 int AreaIndex { get; set; }

VB.NET

Public Property AreaIndex As Integer

Property Value

Type	Description
Int32	A zero-based integer that specifies the field’s index among the other fields displayed within the same area.

Remarks

A field can be placed within one of four areas: Filter Header Area, Column Header Area, Row Header Area or Data Header Area. The AreaIndex property specifies the field’s index among the other fields displayed within the same area.

If the current field is hidden, assigning a positive value to the AreaIndex property makes the field visible. If the field is visible, assigning a negative value to this property will hide the field and will set its AreaIndex property to -1.

Use the PivotGridField.Area property to specify the area in which the field is displayed. The field’s position can also be set via the PivotGridField.SetAreaPosition method.

Dragging a field from one area to another automatically changes the AreaIndex property’s value, and vice versa. Before the field’s location is changed, the DXPivotGrid 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 PivotGridField.Area and AreaIndex properties of the first field in the group. Modifying the PivotGridField.Area and AreaIndex properties for the second and subsequent fields in the group is ignored.

Example

The following example demonstrates how to programmatically 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.

First, data is obtained from an MDB database via the OleDbConnection, OleDbDataAdapter and DataSet components. Secondly, the PivotGridControl is bound to a table in the dataset via the PivotGridControl.DataSource property. Lastly, pivot grid fields are created that will represent datasource fields. 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 add pivot grid fields in XAML, please refer to the How to: Bind a PivotGrid to an MS Access Database 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 Name="pivotGridControl1" 
                               HorizontalAlignment="Left" VerticalAlignment="Top" />
    </Grid>
</Window>

MainWindow.xaml.vb

Imports System
Imports System.Data
Imports System.Data.OleDb
Imports System.Windows
Imports DevExpress.Xpf.PivotGrid

Namespace HowToBindToMDB

    Partial Public Class MainWindow
        Inherits Window
        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub Window_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
            ' Create a connection object.
            Dim connection As _
                New OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=NWIND.MDB")
            ' Create a data adapter.
            Dim adapter As _
                New OleDbDataAdapter("SELECT * FROM SalesPerson", connection)

            ' Create and fill a dataset.
            Dim sourceDataSet As New DataSet()
            adapter.Fill(sourceDataSet, "SalesPerson")

            ' Assign the data source to the PivotGrid control.
            pivotGridControl1.DataSource = sourceDataSet.Tables("SalesPerson")

            pivotGridControl1.BeginUpdate()

            ' Create a row pivot grid field bound to the Country datasource field.
            Dim fieldCountry As New PivotGridField("Country", FieldArea.RowArea)

            ' Create a row pivot grid field bound to the Sales Person datasource field.
            Dim fieldCustomer As New PivotGridField("Sales Person", FieldArea.RowArea)
            fieldCustomer.Caption = "Customer"

            ' Create a column pivot grid field bound to the OrderDate datasource field.
            Dim fieldYear As New PivotGridField("OrderDate", FieldArea.ColumnArea)
            fieldYear.Caption = "Year"
            ' Group field values by years.
            fieldYear.GroupInterval = FieldGroupInterval.DateYear

            ' Create a column pivot grid field bound to the CategoryName datasource field.
            Dim fieldCategoryName As New PivotGridField("CategoryName", FieldArea.ColumnArea)
            fieldCategoryName.Caption = "Product Category"

            ' Create a filter pivot grid field bound to the ProductName datasource field.
            Dim fieldProductName As New PivotGridField("ProductName", FieldArea.FilterArea)
            fieldProductName.Caption = "Product Name"

            ' Create a data pivot grid field bound to the 'Extended Price' datasource field.
            Dim fieldExtendedPrice As New PivotGridField("Extended Price", FieldArea.DataArea)
            ' Specify the formatting setting to format summary values as integer currency amount.
            fieldExtendedPrice.CellFormat = "c0"

            ' Add the fields to the control's field collection.         
            pivotGridControl1.Fields.AddRange(fieldCountry, fieldCustomer, fieldCategoryName, _
                                              fieldProductName, fieldYear, fieldExtendedPrice)

            ' Arrange the row fields within the Row Header Area.
            fieldCountry.AreaIndex = 0
            fieldCustomer.AreaIndex = 1

            ' Arrange the column fields within the Column Header Area.
            fieldCategoryName.AreaIndex = 0
            fieldYear.AreaIndex = 1

            pivotGridControl1.EndUpdate()
        End Sub
    End Class
End Namespace

MainWindow.xaml.cs

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

namespace HowToBindToMDB {

    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
        }

        private void Window_Loaded(object sender, RoutedEventArgs e) {
            // Create a connection object.
            OleDbConnection connection =
                new OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=NWIND.MDB");
            // Create a data adapter.
            OleDbDataAdapter adapter =
                new OleDbDataAdapter("SELECT * FROM SalesPerson", connection);

            // Create and fill a dataset.
            DataSet sourceDataSet = new DataSet();
            adapter.Fill(sourceDataSet, "SalesPerson");

            // Assign the data source to the PivotGrid control.
            pivotGridControl1.DataSource = sourceDataSet.Tables["SalesPerson"];

            pivotGridControl1.BeginUpdate();

            // Create a row pivot grid field bound to the Country datasource field.
            PivotGridField fieldCountry = new PivotGridField("Country", FieldArea.RowArea);

            // Create a row pivot grid field bound to the Sales Person datasource field.
            PivotGridField fieldCustomer = new PivotGridField("Sales Person", FieldArea.RowArea);
            fieldCustomer.Caption = "Customer";

            // Create a column pivot grid field bound to the OrderDate datasource field.
            PivotGridField fieldYear = new PivotGridField("OrderDate", FieldArea.ColumnArea);
            fieldYear.Caption = "Year";
            // Group field values by years.
            fieldYear.GroupInterval = FieldGroupInterval.DateYear;

            // Create a column pivot grid field bound to the CategoryName datasource field.
            PivotGridField fieldCategoryName = new PivotGridField("CategoryName", FieldArea.ColumnArea);
            fieldCategoryName.Caption = "Product Category";

            // Create a filter pivot grid field bound to the ProductName datasource field.
            PivotGridField fieldProductName = new PivotGridField("ProductName", FieldArea.FilterArea);
            fieldProductName.Caption = "Product Name";

            // Create a data pivot grid field bound to the 'Extended Price' datasource field.
            PivotGridField fieldExtendedPrice = new PivotGridField("Extended Price", FieldArea.DataArea);

            // Specify the formatting setting to format summary values as integer currency amount.
            fieldExtendedPrice.CellFormat = "c0";

            // Add the fields to the control's field collection.         
            pivotGridControl1.Fields.AddRange(fieldCountry, fieldCustomer,
                fieldCategoryName, fieldProductName, fieldYear, fieldExtendedPrice);

            // Arrange the row fields within the Row Header Area.
            fieldCountry.AreaIndex = 0;
            fieldCustomer.AreaIndex = 1;

            // Arrange the column fields within the Column Header Area.
            fieldCategoryName.AreaIndex = 0;
            fieldYear.AreaIndex = 1;

            pivotGridControl1.EndUpdate();
        }
    }
}

Related GitHub Examples

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

wpf-pivot-grid-apply-format-conditions-to-data-cells/CS/WpfPivotGridConditionalFormatting/MainWindow.xaml#L64

<dxpg:PivotGridField Area="RowArea" FieldName="Country"
                     Name="fieldCountry" AreaIndex="0" />
<dxpg:PivotGridField Area="DataArea" FieldName="Extended Price"

wpf-pivot-grid-implement-custom-summary/CS/DXPivotGrid_CustomSummary/MainWindow.xaml#L13

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

how-to-format-cells-to-show-custom-display-text-t537332/CS/WpfPivotCustomCellValueDisplaytext/MainWindow.xaml#L16

<dxpg:PivotGridControl.Fields>
    <dxpg:PivotGridField Area="DataArea" FieldName="Extended Price" Name="fieldExtendedPrice" AreaIndex="0" />
    <dxpg:PivotGridField Area="RowArea" Caption="Category" FieldName="CategoryName" Name="fieldCategoryName" AreaIndex="0" />

how-to-sort-data-in-server-mode-using-the-customservermodesort-event-t264201/CS/WPFPivotGridCustomServerModeSort/MainWindow.xaml#L15

<dxpg:PivotGridControl.Fields>
    <dxpg:PivotGridField Name="fieldOrderMonth" Area="ColumnArea" AreaIndex="1"
        Caption="Month" FieldName="OrderDate" GroupInterval="DateMonth"

how-to-add-and-remove-items-from-the-filter-drop-down-list-e2402/CS/DXPivotGrid_CustomFilterItems/MainWindow.xaml#L14

<dxpg:PivotGridField Name="fieldCategoryName" FieldName="CategoryName" Area="RowArea"
                     AreaIndex="0" Caption="Category Name"/>
<dxpg:PivotGridField Name="fieldProductName" FieldName="ProductName" Area="RowArea"

C#

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

fieldYear.Caption = "Year";
fieldYear.AreaIndex = 0;

wpf-pivotgridcontrol-providing-a-custom-summary-for-total-grand-total-and-ordinary-cells-t555636/CS/WpfApplication1/CustomTotalGrandTotalBehavior.cs#L31

int lastColumnFieldIndex = PivotGrid.GetFieldsByArea(FieldArea.ColumnArea).Count() - 1;
if (e.RowField.AreaIndex == lastRowFieldIndex && e.ColumnField.AreaIndex == lastColumnFieldIndex)
{

how-to-to-show-top-n-values-calculated-by-a-certain-measure-using-the-context-menu-t353100/CS/ContextMenuToShowTopN_Example/MainWindow.xaml.cs#L125

{
    var fields = valueItem.PivotGrid.GetFieldsByArea(valueItem.IsColumn ? FieldArea.ColumnArea : FieldArea.RowArea).Where(f => f.AreaIndex <= valueItem.Field.AreaIndex);
    return fields.

VB.NET

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

fieldYear.Caption = "Year"
fieldYear.AreaIndex = 0

wpf-pivotgridcontrol-providing-a-custom-summary-for-total-grand-total-and-ordinary-cells-t555636/VB/WpfApplication1/CustomTotalGrandTotalBehavior.vb#L31

Dim lastColumnFieldIndex As Integer = PivotGrid.GetFieldsByArea(FieldArea.ColumnArea).Count() - 1
If e.RowField.AreaIndex = lastRowFieldIndex AndAlso e.ColumnField.AreaIndex = lastColumnFieldIndex Then
    'this is Ordinary cell

how-to-to-show-top-n-values-calculated-by-a-certain-measure-using-the-context-menu-t353100/VB/ContextMenuToShowTopN_Example/MainWindow.xaml.vb#L119

Private Shared Function GetConditions(ByVal valueItem As FieldValueElementData) As List(Of KeyValuePair(Of PivotGridField, Object))
    Dim fields = valueItem.PivotGrid.GetFieldsByArea(If(valueItem.IsColumn, FieldArea.ColumnArea, FieldArea.RowArea)).Where(Function(f) f.AreaIndex <= valueItem.Field.AreaIndex)
    Return fields.Select(Function(f) New KeyValuePair(Of PivotGridField, Object)(f, valueItem.PivotGrid.GetFieldValue(f, valueItem.MinIndex))).ToList()