PivotGridControl.GetFieldsByArea(PivotArea) Method

Returns a list of fields displayed in the specified area.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.1.dll

Declaration

C#

public List<PivotGridField> GetFieldsByArea(
    PivotArea area
)

VB.NET

Public Function GetFieldsByArea(
    area As PivotArea
) As List(Of PivotGridField)

Parameters

Name	Type	Description
area	PivotArea	A PivotArea value that identifies the required area.

Returns

Type	Description
List<PivotGridField>	A list of visible fields displayed in the specified area.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetFieldsByArea(PivotArea) method.

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-reorder-pivotgrid-rows-and-columns-by-drag-and-drop-e4545/CS/ReorderHelper.cs#L102

{
    foreach (PivotGridField field in targetPivot.GetFieldsByArea(PivotArea.RowArea))
    {

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

    rowCount = pivotGridControl1.Cells.RowCount;
List<PivotGridField> columnFields = pivotGridControl1.GetFieldsByArea(PivotArea.ColumnArea),
    rowFields = pivotGridControl1.GetFieldsByArea(PivotArea.RowArea);

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

bool _isFirstItem = true;
foreach (PivotGridField field in pivot.GetFieldsByArea(PivotArea.DataArea))
{

how-to-avoid-production-of-unnecessary-column-and-merging-of-cells-in-excel-export-e2346/CS/WindowsApplication53/Form1.cs#L97

string text = "ColumnFields: ";
List<PivotGridField> fields = pivot.GetFieldsByArea(PivotArea.ColumnArea);
for (int i = 0; i < fields.Count ; i++)

sort-a-xtrapivotgrid-by-clicking-on-a-field-value-and-toggle-sort-order-e2705/CS/Form1.cs#L41

PivotArea otherArea = GetOtherArea(e.IsColumn);
List<PivotGridField> otherFields = pivotGridControl1.GetFieldsByArea(otherArea);
PivotSortOrder? sortOrder = GetSummarySortOrder(e.Item);

VB.NET

how-to-reorder-pivotgrid-rows-and-columns-by-drag-and-drop-e4545/VB/ReorderHelper.vb#L119

Private Sub InitRowsOrder()
    For Each field As PivotGridField In targetPivot_Renamed.GetFieldsByArea(PivotArea.RowArea)
        InitSingleFieldOrder(field)

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

Dim _isFirstItem As Boolean = True
For Each field As PivotGridField In pivot.GetFieldsByArea(PivotArea.DataArea)
    If (Not _isFirstItem) Then

how-to-avoid-production-of-unnecessary-column-and-merging-of-cells-in-excel-export-e2346/VB/WindowsApplication53/Form1.vb#L87

Dim text As String = "ColumnFields: "
Dim fields As List(Of PivotGridField) = pivot.GetFieldsByArea(PivotArea.ColumnArea)
For i As Integer = 0 To fields.Count - 1

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

Dim columnCount As Integer = pivotGridControl1.Cells.ColumnCount, rowCount As Integer = pivotGridControl1.Cells.RowCount
Dim columnFields As List(Of PivotGridField) = pivotGridControl1.GetFieldsByArea(PivotArea.ColumnArea), rowFields As List(Of PivotGridField) = pivotGridControl1.GetFieldsByArea(PivotArea.RowArea)

how-to-sort-a-xtrapivotgrid-by-clicking-on-a-field-value-e1434/VB/Form1.vb#L40

Dim otherArea As PivotArea = GetOtherArea(e)
Dim otherFields As List(Of PivotGridField) = pivotGridControl1.GetFieldsByArea(otherArea)
For i As Integer = 0 To otherFields.Count - 1