PivotGridFieldBase.AreaIndex Property

Gets or sets the field’s index from among the other fields displayed within the same area.

Namespace: DevExpress.XtraPivotGrid

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

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(-1)]
public virtual int AreaIndex { get; set; }

VB.NET

<DefaultValue(-1)>
Public Overridable Property AreaIndex As Integer

Property Value

Type	Default	Description
Int32	-1	A zero-based integer that specifies the field’s index among the other fields displayed within the same area.

Remarks

Each field can be placed within one of four areas: Filter Header Area, Column Header Area, Row Header Area or Data Header Area. The AreaIndex property specifies the field’s index among the other fields displayed within the same area, and so specifies the field’s visual position. You can use the AllowedAreas property to specify the areas within which the field can be positioned.

When you assign a positive value to the AreaIndex property, you make the current field visible in case it was hidden. Similarly, if the field is visible, a negative value hides the field. In this case, its AreaIndex property value is changed to -1.

Use the Area property to specify the area in which the field is displayed.

Multiple fields can be combined into a group with the PivotGridControl.Groups property. These fields cannot be separated and are always dragged together. To move a group to a specific area or to a new position within the current area use the PivotGridFieldBase.Area and AreaIndex properties of the first field in the group. Modifying the Area and AreaIndex properties for the second and subsequent fields in the group is ignored.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AreaIndex property.

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#

web-forms-pivot-grid-group-field-values-into-the-specified-intervals/CS/CustomGroupInterval/Default.aspx.cs#L40

ASPxPivotGrid1.Fields[0].GroupInterval = DevExpress.XtraPivotGrid.PivotGroupInterval.Custom;
ASPxPivotGrid1.Fields[0].AreaIndex = 0;
ASPxPivotGrid1.Fields[4].Caption = "Year";

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/CS/PivotGridCustomSummaryExample/CustomSummaryHelper.cs#L26

if (groupField.Area == PivotArea.RowArea &&
    (e.RowField == null || e.RowField.AreaIndex < groupField.AreaIndex))
    return true;

winforms-pivot-grid-hide-empty-columns-and-rows/CS/Data.cs#L23

pivot.Fields.AddDataSourceColumn(Widget, PivotArea.RowArea);
pivot.Fields.AddDataSourceColumn(Month, PivotArea.ColumnArea).AreaIndex = 0;
pivot.Fields.AddDataSourceColumn(RetailPrice, PivotArea.DataArea);

winforms-pivot-grid-hide-specific-columns-and-rows/CS/Data.cs#L23

pivot.Fields.AddDataSourceColumn(Widget, PivotArea.RowArea);
pivot.Fields.AddDataSourceColumn(Month, PivotArea.ColumnArea).AreaIndex = 0;
pivot.Fields.AddDataSourceColumn(RetailPrice, PivotArea.DataArea);

winforms-pivot-split-field-value-cells/CS/Data.cs#L23

pivot.Fields.AddDataSourceColumn(Widget, PivotArea.RowArea);
pivot.Fields.AddDataSourceColumn(Month, PivotArea.ColumnArea).AreaIndex = 0;
pivot.Fields.AddDataSourceColumn(RetailPrice, PivotArea.DataArea);

VB.NET

web-forms-pivot-grid-group-field-values-into-the-specified-intervals/VB/CustomGroupInterval/Default.aspx.vb#L47

ASPxPivotGrid1.Fields(0).GroupInterval = DevExpress.XtraPivotGrid.PivotGroupInterval.Custom
ASPxPivotGrid1.Fields(0).AreaIndex = 0
ASPxPivotGrid1.Fields(4).Caption = "Year"

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/VB/PivotGridCustomSummaryExample/CustomSummaryHelper.vb#L26

End If
If groupField.Area = PivotArea.RowArea AndAlso (e.RowField Is Nothing OrElse e.RowField.AreaIndex < groupField.AreaIndex) Then
    Return True

winforms-pivot-grid-hide-empty-columns-and-rows/VB/Data.vb#L35

pivot.Fields.AddDataSourceColumn(Widget, PivotArea.RowArea)
pivot.Fields.AddDataSourceColumn(Month, PivotArea.ColumnArea).AreaIndex = 0
pivot.Fields.AddDataSourceColumn(RetailPrice, PivotArea.DataArea)

winforms-pivot-grid-hide-specific-columns-and-rows/VB/Data.vb#L27

pivot.Fields.AddDataSourceColumn(Widget, PivotArea.RowArea)
pivot.Fields.AddDataSourceColumn(Month, PivotArea.ColumnArea).AreaIndex = 0
pivot.Fields.AddDataSourceColumn(RetailPrice, PivotArea.DataArea)

winforms-pivot-split-field-value-cells/VB/Data.vb#L27

pivot.Fields.Add(Widget, PivotArea.RowArea)
pivot.Fields.Add(Month, PivotArea.ColumnArea).AreaIndex = 0
pivot.Fields.Add(RetailPrice, PivotArea.DataArea)