PivotGridFieldBase Class

Represents the base class for the PivotGridField class.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v17.2.Core.dll

Declaration

C#

public class PivotGridFieldBase :
    Component,
    IComponentLoading,
    IXtraSerializableLayoutEx,
    IViewBagOwner,
    IXtraSupportDeserializeCollectionItem,
    IXtraSupportDeserializeCollection,
    IXtraSerializable,
    IDataColumnInfo,
    IPivotGridDataContainerCore,
    IXtraSupportShouldSerialize

VB.NET

Public Class PivotGridFieldBase
    Inherits Component
    Implements IComponentLoading,
               IXtraSerializableLayoutEx,
               IViewBagOwner,
               IXtraSupportDeserializeCollectionItem,
               IXtraSupportDeserializeCollection,
               IXtraSerializable,
               IDataColumnInfo,
               IPivotGridDataContainerCore,
               IXtraSupportShouldSerialize

Related API Members

The following members accept/return PivotGridFieldBase objects:

Show 20 links

Library	Related API Members
Cross-Platform Class Library	PivotGridCustomSummaryEventArgsBase<T>.DataField
	PivotGridCustomTotalCollectionBase.Field
	PivotGridFieldCollectionBase.Add()
	PivotGridFieldCollectionBase.Add(String, PivotArea)
	PivotGridFieldCollectionBase.GetFieldByName(String)
	PivotGridFieldCollectionBase.Item[Int32]
	PivotGridFieldCollectionBase.Item[String]
	PivotGridFieldFilterValues.Field
	PivotGridFieldSortBySummaryInfo.Field
	PivotGridFieldSortBySummaryInfo.Owner
	PivotGridFieldSortCondition.Field
	PivotGridGroup.Item[Int32]
	PivotGroupFilterValue.Field
	PivotSummaryDataSource.GetField(Int32)
	PivotSummaryFilter.ColumnField
	PivotSummaryFilter.RowField
WinForms Controls	PivotGridMenuEventArgsBase.Field
	PivotGridStyleFormatCondition.Field
Reporting	XRPivotGrid.GetFieldByArea(PivotArea, Int32)
ASP.NET Web Forms Controls	PivotGridFieldCollection.GetFieldByClientID(String)

Remarks

The PivotGridFieldBase class serves as the base class for the PivotGridField class. This class represents a field within the PivotGridField control.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PivotGridFieldBase 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-generate-an-mdx-query-automatically-according-to-the-current-pivot-grid-layout-e2299/CS/WindowsApplication10/CubeToTableAdapte.cs#L91

public string Caption;
public List<PivotGridFieldBase> Fields;

how-to-handle-a-collapse-all-expand-all-menu-item-click-e281/CS/Form1.cs#L49

public event EventHandler<FieldExpandedEventArgs> FieldExpandedAll;
internal void RaiseFieldExpandedAll(PivotGridFieldBase field, bool expanded) {
    if(FieldExpandedAll != null)

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

bool IsValueFit(FieldValue value, List<PivotGridFieldSortCondition> conds, PivotGridFieldBase field) {
    for(int i = 0; i < conds.Count; i++) {

XAF_how-to-make-pivotgridcontrol-editable-when-using-the-pivot-chart-analysis-module-e1232/CS/WinSample.Module.Win/PivotGridInplaceEditorsController.cs#L60

public MyPivotGridFieldBuilder(IAnalysisControl owner) : base(owner) { }
protected override void SetupPivotGridField(PivotGridFieldBase field, Type memberType, string displayFormat) {
    base.SetupPivotGridField(field, memberType, displayFormat);

how-to-replace-the-default-filter-popup-with-a-custom-one-made-with-aspxgridview-control-e4669/CS/CustomFilterPopup/FilterPopup.ascx.cs#L37

string[] parameters = e.Parameters.Split(",".ToCharArray());
var field = PivotGrid.Fields.GetFieldByName(parameters[0]);
var selectedValueStr = parameters.Skip(1).OrderBy(v=>v).ToArray();

VB.NET

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

Public Caption As String
Public Fields As List(Of PivotGridFieldBase)

how-to-handle-a-collapse-all-expand-all-menu-item-click-e281/VB/Form1.vb#L56

Public Event FieldExpandedAll As EventHandler(Of FieldExpandedEventArgs)
Friend Sub RaiseFieldExpandedAll(ByVal field As PivotGridFieldBase, ByVal expanded As Boolean)
    RaiseEvent FieldExpandedAll(Me, New FieldExpandedEventArgs(CType(field, PivotGridField), expanded))

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

Private Function IsValueFit(ByVal value As FieldValue, ByVal conds As List(Of PivotGridFieldSortCondition), ByVal field As PivotGridFieldBase) As Boolean
    For i As Integer = 0 To conds.Count - 1

XAF_how-to-make-pivotgridcontrol-editable-when-using-the-pivot-chart-analysis-module-e1232/VB/WinSample.Module.Win/PivotGridInplaceEditorsController.vb#L65

End Sub
Protected Overrides Sub SetupPivotGridField(ByVal field As PivotGridFieldBase, ByVal memberType As Type, ByVal displayFormat As String)
    MyBase.SetupPivotGridField(field, memberType, displayFormat)

Inheritance

Object

MarshalByRefObject

Component

PivotGridFieldBase

XRPivotGridField

MVCxPivotGridField

PivotGridField

PivotGridField