PivotGridControl.FieldValueCollapsed Event

Fires after a field value has been collapsed.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

public event PivotFieldValueEventHandler FieldValueCollapsed
Public Event FieldValueCollapsed As PivotFieldValueEventHandler

Event Data

The FieldValueCollapsed event's data class is PivotFieldValueEventArgs. The following properties provide information specific to this event:

Property Description
CustomTotal Gets the custom total which the currently processed column/row header corresponds to.
Data This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
DataField Gets the data field that specifies the processed value.
Field Gets the field being processed. Inherited from PivotFieldEventArgsBase<T>.
FieldIndex Gets the field position among the visible fields within the header area.
IsCollapsed Gets whether the processed field value is collapsed.
IsColumn Gets whether the field is displayed within the Column Header Area.
IsOthersValue Gets or sets whether the current header corresponds to the "Others" row/column.
Item For internal use.
MaxIndex Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the processed field value.
MinIndex Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the processed field value.
Value Gets the column field or row field value that corresponds to the currently processed column/row header.
ValueType Gets the type of the currently processed header of a column or a row.

Remarks

The FieldValueCollapsed event is raised after a field value has been collapsed by an end-user. Note that it provides a notification only and you cannot cancel the action. To control whether individual field values can be collapsed, handle the PivotGridControl.FieldValueCollapsing event instead.

NOTE

The FieldValueCollapsed and PivotGridControl.FieldValueExpanded events raise when a single value is expanded or collapsed and do not fire when end users expand / collapse fields by using the built-in context menu. To be notified when an end-user clicks the "Expand All" or "Collapse All" menu items, use the PivotGridControl.PopupMenuShowing event. In this case, you can use the PivotContextMenuIds class to identify menu items.

See Also