Tag

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.v19.2.Core.dll

Declaration

[DefaultValue(-1)]
public virtual int AreaIndex { get; set; }
<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.

See Also