Skip to main content

TcxPivotGridField.AreaIndex Property

Specifies the position of the field amongst the other fields within the same area.

Declaration

property AreaIndex: Integer read; write; default cxPivotGridInvalidIndex;

Property Value

Type Default
Integer cxPivotGridInvalidIndex

Remarks

A field can be positioned in one of the available areas: the column header area, row header area, filter header area, data header area. Use the field’s Area property to specify the area in which this field is displayed. The AreaIndex property specifies the field’s position (a zero-based index) amongst the other fields displayed within the same area. This position is determined as if all the field groups within the current area are expanded.

To display a field as outermost or innermost, set its AreaIndex property to 0 and MaxInt, respectively.

Multiple fields can be combined into a group via the pivot grid’s Groups property. These fields cannot be separated and are always moved together. To place a group into a specific area or into a new position within the current area, use either the group’s Area and AreaIndex properties or the Area and AreaIndex properties of the first field in the group. Modifying the Area and AreaIndex properties of the second and subsequent fields in the group is ignored. The values of these properties are the same as the values of the group’s Area and AreaIndex properties.

See Also