PivotGridControl.FieldValueCollapsed Event

Occurs after a field value has been collapsed.

Namespace: DevExpress.Xpf.PivotGrid

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

Declaration

public event PivotFieldValueEventHandler FieldValueCollapsed

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.
DataField Gets the data field that identifies the processed value.
Field Gets the field being processed. Inherited from PivotFieldEventArgs.
FieldIndex Gets the field’s position among the visible fields within the header area.
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.
IsColumn Gets whether the field is displayed within the Column Header Area.
IsOthersValue Gets whether the current header corresponds to the “Others” row/column.
MaxIndex Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the field value currently being processed.
MinIndex Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the field value currently being processed.
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.
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.
ValueType Gets the type of the currently processed column/row header.

The event data class exposes the following methods:

Method Description
ChangeExpandedState() Changes the expanded state of the field value currently being processed.
CreateDrillDownDataSource() Returns a list of records associated with the field value currently being processed.
CreateDrillDownDataSource(Int32, List<String>) Returns a list of records used to calculate a summary value for the specified cell. Allows you to specify the columns, and limit the number of records to be returned.
CreateOlapDrillDownDataSource(Int32, List<String>) Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns, and limit the number of records to be returned.
CreateServerModeDrillDownDataSource(Int32, List<String>) Obsolete. In server mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns, and limit the number of records to be returned.
GetCellValue(Int32, Int32) Returns a value displayed in the specified cell.
GetFieldValue(PivotGridField, Int32) Returns the specified column or row field’s value for the cell addressed by its zero-based index in the Data Area.
GetHigherLevelFields() Returns the parent field(s) for the field value being currently processed.
GetHigherLevelFieldValue(PivotGridField) Returns the value of a specific parent field corresponding to the field value currently being processed.
InvokeEventHandler(Delegate, Object) When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object) When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

The PivotGridControl.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 FieldValueCollapsed event is raised.

See Also