PivotGridField Class

Represents a field within the ASPxPivotGrid control.

Namespace: DevExpress.Web.ASPxPivotGrid

Assembly: DevExpress.Web.ASPxPivotGrid.v17.2.dll

Declaration

C#

public class PivotGridField :
    PivotGridFieldBase,
    IWebControlObject,
    IDataSourceViewSchemaAccessor,
    IDisplayNameProvider,
    IFilterColumn,
    IFilterablePropertyInfo,
    IDesignTimeCollectionItem

VB.NET

Public Class PivotGridField
    Inherits PivotGridFieldBase
    Implements IWebControlObject,
               IDataSourceViewSchemaAccessor,
               IDisplayNameProvider,
               IFilterColumn,
               IFilterablePropertyInfo,
               IDesignTimeCollectionItem

Related API Members

The following members accept/return PivotGridField objects:

Show 22 links

• ASPxPivotGrid.GetFieldByArea(PivotArea, Int32)
• FieldValueCell.DataField
• FieldValueCell.Field
• PivotCustomFilterPopupItemsEventArgs.Field
• PivotFieldStateChangedEventArgs.DataField
• PivotGridCellTemplateContainer.ColumnField
• PivotGridCellTemplateContainer.DataField
• PivotGridCellTemplateContainer.RowField
• PivotGridCellTemplateItem.ColumnField
• PivotGridCellTemplateItem.DataField
• PivotGridCellTemplateItem.RowField
• PivotGridCustomFieldSortEventArgs.Field
• PivotGridFieldCollection.Add(String, PivotArea)
• PivotGridFieldCollection.Item[Int32]
• PivotGridFieldCollection.Item[String]
• PivotGridFieldValueTemplateContainer.Field
• PivotGridFieldValueTemplateItem.Field
• PivotGridHeaderTemplateContainer.Field
• WebCustomExportCellEventArgs.ColumnField
• WebCustomExportCellEventArgs.DataField
• WebCustomExportCellEventArgs.RowField
• WebCustomExportHeaderEventArgs.Field

Remarks

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

The ASPxPivotGrid 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 PivotGridField.FieldName property. Data for unbound fields should be supplied manually - via the ASPxPivotGrid.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#

aspxpivotgrid-how-to-change-the-summary-display-mode-t590012/CS/SummaryDisplayMode/Default.aspx.cs#L23

}
PivotGridField SourceDataField {
    get { return pivotGrid.Fields[SourceDataFieldName]; }

how-to-create-fields-and-assign-a-data-source-at-runtime-e421/CS/BindAndAddFields/Default.aspx.cs#L28

// create fields
PivotGridField fieldEmployee = new PivotGridField();
fieldEmployee.ID = "fieldEmployee";

how-to-use-the-customcellvalues-event-to-display-the-original-values-and-running-total-values-e1962/CS/WebApplication1/Default.aspx.cs#L31

double value = 0;
Dictionary<PivotGridField, object> rowFieldValues = new Dictionary<PivotGridField, object>();
PivotGridField[] rowFields = e.GetRowFields();

how-to-replace-the-default-filter-popup-with-a-custom-one-made-with-the-mvcxgridview-t572362/CS/MPG_CustomFilterPopup/Models/CustomFilterItem.cs#L19

public static CustomFilterItem[] GetItems(DevExpress.Web.ASPxPivotGrid.PivotGridField field) {
    var selectedValues = field.FilterValues.ValuesIncluded;

how-to-implement-customized-percentofrow-percentofcolumn-e1108/CS/Default.aspx.cs#L33

ASPxPivotGrid pivot = sender as ASPxPivotGrid;
PivotGridField dField = pivot.Fields["Quantity"];
object n = e.GetCellValue(dField);

VB.NET

aspxpivotgrid-how-to-change-the-summary-display-mode-t590012/VB/SummaryDisplayMode/Default.aspx.vb#L37

End Property
Private ReadOnly Property SourceDataField() As PivotGridField
    Get

how-to-create-fields-and-assign-a-data-source-at-runtime-e421/VB/BindAndAddFields/Default.aspx.vb#L30

' create fields
Dim fieldEmployee As New PivotGridField()
fieldEmployee.ID = "fieldEmployee"

how-to-use-the-customcellvalues-event-to-display-the-original-values-and-running-total-values-e1962/VB/WebApplication1/Default.aspx.vb#L28

Dim value As Double = 0
Dim rowFieldValues As New Dictionary(Of PivotGridField, Object)()
Dim rowFields() As PivotGridField = e.GetRowFields()

how-to-implement-customized-percentofrow-percentofcolumn-e1108/VB/Default.aspx.vb#L32

Dim pivot As ASPxPivotGrid = TryCast(sender, ASPxPivotGrid)
Dim dField As PivotGridField = pivot.Fields("Quantity")
Dim n As Object = e.GetCellValue(dField)

how-to-replace-the-default-filter-popup-with-a-custom-one-made-with-aspxgridview-control-e4669/VB/CustomFilterPopup/FilterPopup.ascx.vb#L31

Private ReadOnly Property CurrentField() As PivotGridField
    Get

Implements

IFilterablePropertyInfo

Inheritance

Object

MarshalByRefObject

Component

PivotGridFieldBase

PivotGridField

MVCxPivotGridField