PivotGridField Class

Represents a field within the PivotGridControl control.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v17.2.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

PivotGridField objects represent fields within the PivotGridControl control. A field can be displayed within one of four areas: Column Header Area, Row Header Area, Data Area or Filter Header Area. The fields located within these areas are called column fields, row fields, data fields and filter fields, respectively. A field’s area and its position within its area are specified by the PivotGridFieldBase.Area and PivotGridFieldBase.AreaIndex properties.

The PivotGridControl control supports bound and unbound fields. Bound fields get their data from a specific field in the control’s underlying data source. This field is specified by the PivotGridFieldBase.FieldName property. Data for unbound fields should be supplied manually - via the PivotGridControl.CustomUnboundFieldData event.

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