PivotGridField.Name Property

Gets or sets the field’s name.

Namespace: DevExpress.Xpf.PivotGrid

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

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

Declaration

C#

public string Name { get; set; }

VB.NET

Public Property Name As String

Property Value

Type	Description
String	A string which specifies the field’s name.

Remarks

Use the Name property to assign a name to a PivotGridField object created at runtime. To retrieve a field from the control’s field collection by its name use the PivotGridFieldCollection.GetFieldByName method.

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 Name 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#L55

    FieldName="Extended Price"
    Name="fieldSales" />
<dxpg:PivotGridField

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

    FieldName="Extended Price"
    Name="fieldSales" />
<dxpg:PivotGridField

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#

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

{
    if (e.DataField.Name == Name)
    {

VB.NET

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

Private Sub PivotGrid_CustomSummary(ByVal sender As Object, ByVal e As PivotCustomSummaryEventArgs)
    If e.DataField.Name = Name Then
        If (e.ColumnField Is Nothing) OrElse (e.RowField Is Nothing) Then