Pivot Grid Elements That Support Templates

• Apr 15, 2018
• 3 minutes to read

The following table lists all template properties introduced by the Pivot Grid:

Visual Element	Property	Description	Data Context (Binding Source)
Customization Form	PivotGridControl.ExcelFieldListTemplate PivotGridControl.FieldListTemplate	Specifies the template that defines the presentation of the Customization Form.	PivotGridControl
Data Cell	PivotGridControl.FieldCellTemplate PivotGridControl.FieldCellTemplateSelector PivotGridControl.FieldCellKpiTemplate PivotGridControl.FieldCellKpiTemplateSelector PivotGridField.CellTemplate PivotGridField.CellTemplateSelector	Specifies the template that defines the presentation of data cells.	DevExpress.Xpf.PivotGrid.Internal.CellsAreaItem
Drag Indicator	PivotGridControl.FieldHeaderDragIndicatorTemplate	Specifies the template that defines the presentation of the drag indicator.	null (Nothing in Visual Basic)
Field Header	PivotGridControl.FieldHeaderTemplate PivotGridControl.FieldHeaderTemplateSelector PivotGridField.HeaderTemplate PivotGridField.HeaderTemplateSelector	Specifies the template that defines the presentation of field headers.	PivotGridField
Field Header (in a Customization Form, list arrangement)	PivotGridControl.FieldHeaderListTemplate PivotGridControl.FieldHeaderListTemplateSelector PivotGridField.HeaderListTemplate PivotGridField.HeaderListTemplateSelector	Specifies the template that defines the presentation of field headers in the Customization Form when they are arranged in a list.	PivotGridField
Field Header (in a Customization Form, tree arrangement)	PivotGridControl.FieldHeaderTreeViewTemplate PivotGridControl.FieldHeaderTreeViewTemplateSelector PivotGridField.HeaderTreeViewTemplate PivotGridField.HeaderTreeViewTemplateSelector	Specifies the template that defines the presentation of field headers in the Customization Form when they are arranged in a tree.	PivotGridField
Field Value	PivotGridControl.FieldValueTemplate PivotGridControl.FieldValueTemplateSelector PivotGridField.ValueTemplate PivotGridField.ValueTemplateSelector	Specifies the template that defines the presentation of field values.	DevExpress.Xpf.PivotGrid.Internal.FieldValueItem
Focused Cell’s Border	PivotGridControl.FocusedCellBorderTemplate	Specifies the template that defines the presentation of the focused cell’s border.	null (Nothing in Visual Basic)
Resizing Indicator	PivotGridControl.ResizingIndicatorTemplate	Specifies the template that defines the presentation of the resizing indicator.	null (Nothing in Visual Basic)

Example

The following example demonstrates how to use the PivotGridControl‘s PivotGridControl.FieldCellTemplate property to customize the appearance of data cells.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-the-cell-template-e2138.

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"
        xmlns:local="clr-namespace:HowToBindToMDB"
        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="fieldSalesPerson" FieldName="Sales Person" Area="RowArea" />
                <dxpg:PivotGridField Name="fieldYear" FieldName="OrderDate" Area="ColumnArea" 
                                     Caption="Year" GroupInterval="DateYear" />
                <dxpg:PivotGridField Name="fieldExtendedPrice" FieldName="Extended Price" Area="DataArea"
                                     CellFormat="c0" />
            </dxpg:PivotGridControl.Fields>
            <dxpg:PivotGridControl.FieldCellTemplate>
                <DataTemplate>
                    <ProgressBar Name="cellShare" Minimum="0" Margin="3" 
                    Maximum="{Binding Path=RowTotalValue, Mode=OneWay, Converter={local:RoundConverter}}"
                    Value="{Binding Path=Value, Mode=OneWay, Converter={local:RoundConverter}}"
                    HorizontalAlignment="Stretch" VerticalAlignment="Stretch"/>
                </DataTemplate>
            </dxpg:PivotGridControl.FieldCellTemplate>
        </dxpg:PivotGridControl>
    </Grid>
</Window>

MainWindow.xaml.vb

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

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 

    Public Class RoundConverter
        Inherits MarkupExtension
        Implements IValueConverter
        #Region "IValueConverter Members" 
        Public Function Convert(ByVal value As Object, _
                                ByVal targetType As Type, _
                                ByVal parameter As Object, _
                                ByVal culture As System.Globalization.CultureInfo) _
                                As Object Implements IValueConverter.Convert
            Return System.Convert.ToInt32(value)
        End Function 
        Public Function ConvertBack(ByVal value As Object, _
                                    ByVal targetType As Type, _
                                    ByVal parameter As Object, _
                                    ByVal culture As System.Globalization.CultureInfo) _
                                    As Object Implements IValueConverter.ConvertBack
            Throw New NotImplementedException()
        End Function 
        #End Region

        Public Overrides Function ProvideValue(ByVal serviceProvider As IServiceProvider) As Object 
            Return Me 
        End Function 
    End Class 
End Namespace 

MainWindow.xaml.cs

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

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

    public class RoundConverter : MarkupExtension, IValueConverter {
        #region IValueConverter Members
        public object Convert(object value, Type targetType, object parameter, 
                              System.Globalization.CultureInfo culture) {
            return System.Convert.ToInt32(value);
        }
        public object ConvertBack(object value, Type targetType, object parameter, 
                                  System.Globalization.CultureInfo culture) {
            throw new NotImplementedException();
        }
        #endregion

        public override object ProvideValue(IServiceProvider serviceProvider) {
            return this;
        }
    }
}