ASPxPivotGrid.GetFieldByArea(PivotArea, Int32) Method

Returns a pivot grid field located at the specified position within the specified area.

Namespace: DevExpress.Web.ASPxPivotGrid

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

NuGet Package: DevExpress.Web

Declaration

C#

public PivotGridField GetFieldByArea(
    PivotArea area,
    int areaIndex
)

VB.NET

Public Function GetFieldByArea(
    area As PivotArea,
    areaIndex As Integer
) As PivotGridField

Parameters

Name	Type	Description
area	PivotArea	A PivotArea enumeration value that specifies the area where the required pivot grid field is displayed.
areaIndex	Int32	An integer value that specifies the pivot grid field’s position from among the other fields displayed within the same area.

Returns

Type	Description
PivotGridField	A PivotGridField object that represents the pivot grid field located at the specified position within the specified area. null (Nothing) in Visual Basic) if the file was not found.

Remarks

The following example shows how to obtain the second field located within the Column Header Area.

C#

// Quarter field
PivotGridField pgField =
    pivotGrid.GetFieldByArea(DevExpress.XtraPivotGrid.PivotArea.ColumnArea, 1);

VB.NET

Dim pgField = pivotGrid.GetFieldByArea(DevExpress.XtraPivotGrid.PivotArea.ColumnArea, 1)

To obtain all pivot grid fields located in the specified area, use the ASPxPivotGrid.GetFieldsByArea method.