PivotGridOptionsDataField.AreaIndex Property

Gets or sets the position of the data field headers.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
Int32	-1	An integer which specifies the position of the data field headers within the hierarchy of field values.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to AreaIndex
WinForms Controls	PivotGridControl	.OptionsDataField.AreaIndex
ASP.NET Controls and MVC Extensions	ASPxPivotGrid	.OptionsDataField.AreaIndex
	MVCxPivotGrid	.OptionsDataField.AreaIndex
	PivotGridSettings	.OptionsDataField.AreaIndex
Reporting	XRPivotGrid	.OptionsDataField.AreaIndex

Remarks

Data field headers are displayed when the XtraPivotGrid control contains two or more data fields. By default, the AreaIndex property is set to -1, so the data field headers are displayed immediately above the Data Area when they are positioned within the column area (or immediately to the left of the Data Area when positioned within the row area):

Setting the AreaIndex property to 0 displays data field headers above the field values of the first column field:

If the AreaIndex property is set to 1 the data field headers will be displayed under the field values of the first column field, as in the image below:

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#

how-to-hide-particular-rows-and-columns-e2767/CS/ASPxPivotGrid_HidingColumnsAndRows/Data.cs#L36

    pivot.OptionsDataField.Area = PivotDataArea.ColumnArea;
    pivot.OptionsDataField.AreaIndex = 1;
}

how-to-locate-field-value-cells-matching-a-particular-condition-e2770/CS/ASPxPivotGrid_FindCells/Data.cs#L35

    pivot.OptionsDataField.Area = PivotDataArea.ColumnArea;
    pivot.OptionsDataField.AreaIndex = 1;
}

how-to-split-field-value-cells-e2762/CS/ASPxPivotGrid_SplittingCells/Data.cs#L34

    pivot.OptionsDataField.Area = PivotDataArea.ColumnArea;
    pivot.OptionsDataField.AreaIndex = 1;
}

how-to-locate-field-value-cells-matching-a-particular-condition-e2772/CS/Data.cs#L34

    pivot.OptionsDataField.Area = PivotDataArea.ColumnArea;
    pivot.OptionsDataField.AreaIndex = 1;
}

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

    pivot.OptionsDataField.Area = PivotDataArea.ColumnArea;
    pivot.OptionsDataField.AreaIndex = 1;
}

VB.NET

how-to-hide-particular-rows-and-columns-e2767/VB/ASPxPivotGrid_HidingColumnsAndRows/Data.vb#L40

    pivot.OptionsDataField.Area = PivotDataArea.ColumnArea
    pivot.OptionsDataField.AreaIndex = 1
End Sub

how-to-locate-field-value-cells-matching-a-particular-condition-e2770/VB/ASPxPivotGrid_FindCells/Data.vb#L38

    pivot.OptionsDataField.Area = PivotDataArea.ColumnArea
    pivot.OptionsDataField.AreaIndex = 1
End Sub

how-to-split-field-value-cells-e2762/VB/ASPxPivotGrid_SplittingCells/Data.vb#L37

    pivot.OptionsDataField.Area = PivotDataArea.ColumnArea
    pivot.OptionsDataField.AreaIndex = 1
End Sub

how-to-locate-field-value-cells-matching-a-particular-condition-e2772/VB/Data.vb#L38

    pivot.OptionsDataField.Area = PivotDataArea.ColumnArea
    pivot.OptionsDataField.AreaIndex = 1
End Sub

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

    pivot.OptionsDataField.Area = PivotDataArea.ColumnArea
    pivot.OptionsDataField.AreaIndex = 1
End Sub