PivotGridField Class

A field within the PivotGridControl control.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v18.1.dll

Declaration

C#

public class PivotGridField :
    PivotGridFieldBase,
    IPivotGridViewInfoDataOwner,
    ISupportLookAndFeel

VB.NET

Public Class PivotGridField
    Inherits PivotGridFieldBase
    Implements IPivotGridViewInfoDataOwner,
               ISupportLookAndFeel

Related API Members

The following members accept/return PivotGridField objects:

Show 31 links

• CustomExportCellEventArgs.ColumnField
• CustomExportCellEventArgs.DataField
• CustomExportCellEventArgs.RowField
• FilterPopupExcelCustomizeTemplateEventArgs.Field
• FilterPopupExcelDataEventArgs.Field
• FilterPopupExcelEventArgs.Field
• FilterPopupExcelPrepareTemplateEventArgs.Field
• FilterPopupExcelQueryFilterCriteriaEventArgs.Field
• FormatRuleFieldIntersectionSettings.Column
• FormatRuleFieldIntersectionSettings.Row
• PivotCustomDrawCellBaseEventArgs.ColumnField
• PivotCustomDrawCellBaseEventArgs.DataField
• PivotCustomDrawCellBaseEventArgs.RowField
• PivotCustomDrawFieldHeaderEventArgs.Field
• PivotCustomDrawFieldValueEventArgs.Field
• PivotCustomFilterPopupItemsEventArgs.Field
• PivotFieldImageIndexEventArgs.DataField
• PivotFieldImageIndexEventArgs.Field
• PivotGridControl.GetFieldAt(Point)
• PivotGridControl.GetFieldByArea(PivotArea, Int32)
• PivotGridCustomTotalCollection.Field
• PivotGridFieldCollection.Add()
• PivotGridFieldCollection.Add(String, PivotArea)
• PivotGridFieldCollection.GetFieldByName(String)
• PivotGridFieldCollection.Item[Int32]
• PivotGridFieldCollection.Item[String]
• PivotGridFormatRule.Measure
• PivotGridHeadersAreaHitInfo.Field
• PivotGridHitInfo.HeaderField
• PivotGridMenuItemClickEventArgs.Field
• PopupMenuShowingEventArgs.Field

Remarks

A PivotGridField object is a field in the Pivot Grid control.

A field can be located in one of following areas:

Area	Field Type	PivotGridFieldBase.Area value
Column Header Area	Column Field	PivotArea.ColumnArea
Row Header Area	Row Field	PivotArea.RowArea
Data Area	Data Field	PivotArea.DataArea
Filter Header Area	Filter Field	PivotArea.FilterArea

The field’s position within its area is specified by the PivotGridFieldBase.AreaIndex property.

Fields can be bound and unbound. Bound fields get their data from a data source field whose name equals the PivotDataField.Name property value. Data for unbound fields should be supplied manually - by handling the PivotGridControl.CustomUnboundFieldData event.

Tip

To obtain distinct field values which can be used to filter a Pivot Grid’s data, call the PivotGridFieldBase.GetUniqueValues method. See the Filtering Overview topic for more information on Pivot Grid’s data filtering.

Use the following methods to obtain field data:

Method	Description
PivotGridFieldBase.GetUniqueValues	Obtains an array of distinct field values from the underlying data source. This method is used to fill in field’s Filter Editors.
PivotGridFieldBase.GetAvailableValues	Obtains an array of distinct field values contained in the records which are left after applying filters to other fields.
PivotGridFieldBase.GetVisibleValues	Obtains a collection of unique field values contained in the records displayed in the Pivot Grid. Thus, these records are left after applying a field’s filter to the field’s available values (values contained in the records which are left after applying filters to other fields).

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PivotGridField class.

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.

C#

how-to-implement-sorting-for-a-custom-cell-value-e2149/CS/ImplementSortingforaCustomCellValue/Form1.cs#L42

List<object> rowValues = new List<object>();
foreach(PivotGridField field in e.GetRowFields()) {
    rowValues.Add(UpdateValue(field, e.RowIndex, e));

how-to-represent-the-pivotgridcontrols-data-within-xtracharts-e549/CS/Form1.cs#L21

private DevExpress.XtraEditors.SimpleButton simpleButton1;
private DevExpress.XtraPivotGrid.PivotGridField categoryName;
private DevExpress.XtraPivotGrid.PivotGridField productName;

how-to-generate-an-mdx-query-automatically-according-to-the-current-pivot-grid-layout-e2299/CS/WindowsApplication10/QueryStringBuilder.cs#L52

bool _isFirstItem = true;
foreach (PivotGridField field in pivot.Fields)
{

how-to-create-a-custom-exporter-for-the-pivotgridcontrol-by-using-the-xtrareport-suite-this-e2231/CS/Report_at_Runtime/PivotReportGenerator.cs#L40

string tempRowText = "";
List<PivotGridField> fieldsInRowArea = GetFieldsInArea(pivot, PivotArea.RowArea);
for (int i = 0; i < pivot.Cells.RowCount; i++)

how-to-create-a-custom-chart-data-source-e2520/CS/CustomChartDataSourceWin/Form1.cs#L33

decimal value = 0;
Dictionary<PivotGridField, object> columnFieldValues = new Dictionary<PivotGridField, object>();
PivotGridField[] columnFields = e.GetColumnFields();

VB.NET

how-to-implement-sorting-for-a-custom-cell-value-e2149/VB/ImplementSortingforaCustomCellValue/Form1.vb#L44

Dim rowValues As New List(Of Object)()
For Each field As PivotGridField In e.GetRowFields()
    rowValues.Add(UpdateValue(field, e.RowIndex, e))

how-to-represent-the-pivotgridcontrols-data-within-xtracharts-e549/VB/Form1.vb#L22

        Private WithEvents simpleButton1 As DevExpress.XtraEditors.SimpleButton
        Private categoryName As DevExpress.XtraPivotGrid.PivotGridField
'INSTANT VB NOTE: The variable productName was renamed since Visual Basic does not allow variables and other class members to have the same name:

how-to-enable-users-to-design-pivotgridcontrol-format-conditions-at-runtime-t145142/VB/PivotGridFormatCondition/ViewFormatDesigner.vb#L13

Private Pivot As PivotGridControl
Protected field As PivotGridField
Protected simpleConditionDesigner As SimpleConditionDesigner

how-to-generate-an-mdx-query-automatically-according-to-the-current-pivot-grid-layout-e2299/VB/WindowsApplication10/QueryStringBuilder.vb#L55

Dim _isFirstItem As Boolean = True
For Each field As PivotGridField In pivot.Fields
    If field.Area = PivotArea.DataArea OrElse field.Visible = False OrElse field.InnerGroupIndex > 0 Then

how-to-create-a-custom-exporter-for-the-pivotgridcontrol-by-using-the-xtrareport-suite-this-e2231/VB/Report_at_Runtime/PivotReportGenerator.vb#L39

Dim tempRowText As String = ""
Dim fieldsInRowArea As List(Of PivotGridField) = GetFieldsInArea(pivot, PivotArea.RowArea)
For i As Integer = 0 To pivot.Cells.RowCount - 1

Inheritance

Object

MarshalByRefObject

Component

PivotGridFieldBase

PivotGridField