Pivot-Columns.md

layout	post
title	Pivot Columns in Windows Forms Pivot Grid control | Syncfusion
description	Learn about Pivot Columns support in Syncfusion Windows Forms Pivot Grid control, its elements and more details.
platform	windowsforms
control	PivotGrid
documentation	ug

Pivot Columns in Windows Forms Pivot Grid

Pivot columns are defined by using the PivotItem object which holds the information needed for columns that appear in the pivot grid control.

Defining pivot columns using pivot items

To define a pivot column item, the following properties of PivotItem object are used.

Property Name	Description	Type
{{'[Comparer](https://help.syncfusion.com/cr/windowsforms/Syncfusion.PivotAnalysis.Base.PivotItem.html#Syncfusion_PivotAnalysis_Base_PivotItem_Comparer)'| markdownify }}	Gets or sets the IComparer object used for sorting. If this value is null, then sorting will be performed under the assumption that this field is IComparable.	IComparer
{{'[FieldHeader](https://help.syncfusion.com/cr/windowsforms/Syncfusion.PivotAnalysis.Base.PivotItem.html#Syncfusion_PivotAnalysis_Base_PivotItem_FieldHeader)'| markdownify }}	Gets or sets the title you want to see in the header for this pivot item.	string
{{'[FieldMappingName](https://help.syncfusion.com/cr/windowsforms/Syncfusion.PivotAnalysis.Base.PivotItem.html#Syncfusion_PivotAnalysis_Base_PivotItem_FieldMappingName)'| markdownify }}	Gets or sets the property's mapping name.	string
{{'[Format](https://help.syncfusion.com/cr/windowsforms/Syncfusion.PivotAnalysis.Base.PivotItem.html#Syncfusion_PivotAnalysis_Base_PivotItem_Format)'| markdownify }}	Gets or sets the format item for the specified field.	string
{{'[TotalHeader](https://help.syncfusion.com/cr/windowsforms/Syncfusion.PivotAnalysis.Base.PivotItem.html#Syncfusion_PivotAnalysis_Base_PivotItem_TotalHeader)'| markdownify }}	Gets or sets the string you want to append to the pivot item's summary cells.	string

Refer to the below code sample for adding pivot column item in the pivot grid control.

{% tabs %}

{% highlight c# %}

// Defining pivot item PivotItem pivotItem = new PivotItem() { FieldHeader = "Country", FieldMappingName = "Country", TotalHeader = "Total" };

// Adding pivot column item to pivot grid this.pivotGridControl1.PivotColumns.Add(pivotItem);

{% endhighlight %}

{% highlight vb %}

' Defining pivot item Dim pivotItem As New PivotItem() With {.FieldHeader = "Country", .FieldMappingName = "Country", .TotalHeader = "Total"}

' Adding pivot column item to pivot grid Me.pivotGridControl1.PivotColumns.Add(pivotItem)

{% endhighlight %}

{% endtabs %}

Synchronizing pivot columns

To synchronize the newly added or modified pivot column items with the pivot grid control, the SynchronizePivotItems method will be used. This method will be invoked whenever the collection of pivot column items gets changed.

Sorting pivot columns

By default, the pivot grid control sorts the column data in ascending order. The sorting order can be changed by defining custom comparer and it needs to be assigned using the Comparer property of corresponding pivot item.

Refer to the below code sample to define comparer for sorting the column data in descending order.

{% tabs %}

{% highlight c# %}

public partial class Form1 : Form { public Form1() { ...... this.pivotGridControl1.PivotColumns.Add(new PivotItem { FieldMappingName = "Country", Comparer = new ReverseOrderComparer() }); ...... } }

// Reverse order comparer for sorting the data in descending order public class ReverseOrderComparer : IComparer { public int Compare(object x, object y) { if (x == null && y == null) return 0; else if (y == null) return 1; else if (x == null) return -1; else return -x.ToString().CompareTo(y.ToString()); } }

{% endhighlight %}

{% highlight vb %}

Partial Public Class Form1 Inherits Form Public Sub New() ..... Me.pivotGridControl1.PivotColumns.Add(New PivotItem With {.FieldMappingName = "Country", .Comparer = New ReverseOrderComparer()}) ..... End Sub End Class

' Reverse order comparer for sorting the data in descending order Public Class ReverseOrderComparer Inherits IComparer

Public Function Compare(ByVal x As Object, ByVal y As Object) As Integer
    If x Is Nothing AndAlso y Is Nothing Then
        Return 0
    ElseIf y Is Nothing Then
        Return 1
    ElseIf x Is Nothing Then
        Return -1
    Else
        Return -x.ToString().CompareTo(y.ToString())
    End If
End Function

End Class

{% endhighlight %}

{% endtabs %}

Set the width for the pivot columns

The width of the pivot columns can be changed using the QueryColWidth event.

Refer the below code snippet to change the width of the pivot columns by using the column index.

{% tabs %}

{% highlight c# %}

pivotGridControl1.TableModel.QueryColWidth += TableModel_QueryColWidth;

private void TableModel_QueryColWidth(object sender, Syncfusion.Windows.Forms.Grid.GridRowColSizeEventArgs e) { if (e.Index > 2) { e.Size = 150; e.Handled = true; } }

{% endhighlight %}

{% highlight vb %}

AddHandler pivotGridControl1.TableModel.QueryColWidth, AddressOf TableModel_QueryColWidth

Private Sub TableModel_QueryColWidth(ByVal sender As Object,ByVal e As Syncfusion.Windows.Forms.Grid.GridRowColSizeEventArgs) If e.Index > 2 Then e.Size = 150 e.Handled = True End If End Sub

{% endhighlight %}

{% endtabs %}