Skip to main content
Tag

PivotGridField.Area Property

Gets or sets the area in which the field is displayed. This is a dependency property.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v14.2.dll

#Declaration

[XtraSerializableProperty]
[XtraSerializablePropertyId(4)]
public FieldArea Area { get; set; }

#Property Value

Type Description
FieldArea

A FieldArea value that specifies the area in which the field is displayed.

#Remarks

A field can be placed in one of four areas: Filter Header Area, Column Header Area, Row Header Area or Data Header Area. The Area property specifies the area in which the field is displayed. The field can also be positioned using the PivotGridField.SetAreaPosition method. To get the field's position among the other fields within the same area, use the PivotGridField.AreaIndex property.

The PivotGridField.AllowedAreas property specifies in which areas the field can be located. To obtain whether the field can be displayed in a particular area, use the PivotGridField.IsAreaAllowed property.

Dragging a field from one area to another automatically changes the Area property value, and vice versa. Before the field location is changed, PivotGridControl fires the PivotGridControl.FieldAreaChanging event, allowing you to cancel the action. After the location has been changed, the PivotGridControl.FieldAreaChanged event is fired.

Multiple fields can be combined into a group via 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 Area and PivotGridField.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