PivotGridControl.FieldValueCollapsing Event

Occurs when a field value is about to be collapsed, allowing cancellation of the action.

Namespace: DevExpress.Xpf.PivotGrid

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

Declaration

C#

public event PivotFieldValueCancelEventHandler FieldValueCollapsing

VB.NET

Public Event FieldValueCollapsing As PivotFieldValueCancelEventHandler

Event Data

The FieldValueCollapsing event's handler receives an argument of the PivotFieldValueCancelEventArgs type. The following properties provide information specific to this event:

Property	Description
Cancel	Gets or sets whether the field value can be expanded/collapsed.
CustomTotal	Gets the custom total which the currently processed column/row header corresponds to. Inherited from PivotFieldValueEventArgs.
DataField	Gets the data field which identifies the processed value. Inherited from PivotFieldValueEventArgs.
Field	Gets the field being processed. Inherited from PivotFieldEventArgs.
FieldIndex	Gets the field's position among the visible fields within the header area. Inherited from PivotFieldValueEventArgs.
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
IsCollapsed	Gets whether the processed field value is collapsed. Inherited from PivotFieldValueEventArgs.
IsColumn	Gets whether the field is displayed within the Column Header Area. Inherited from PivotFieldValueEventArgs.
IsOthersValue	Gets whether the current header corresponds to the "Others" row/column. Inherited from PivotFieldValueEventArgs.
MaxIndex	Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the field value currently being processed. Inherited from PivotFieldValueEventArgs.
MinIndex	Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the field value currently being processed. Inherited from PivotFieldValueEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Selected	Gets whether the processed field value is selected. Inherited from PivotFieldValueEventArgs.
Source	Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.
Value	Gets the column field or row field value which the currently processed column/row header corresponds to. Inherited from PivotFieldValueEventArgs.
ValueType	Gets the type of the currently processed column/row header. Inherited from PivotFieldValueEventArgs.

Remarks

The FieldValueCollapsing event is raised before a field value is collapsed by an end-user, allowing you to cancel this action. After the field value has been collapsed, the PivotGridControl.FieldValueCollapsed event is raised.