PivotGridControl.FieldValueCollapsing Event

Enables you to control whether field values can be collapsed.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

public event PivotFieldValueCancelEventHandler FieldValueCollapsing
Public Event FieldValueCollapsing As PivotFieldValueCancelEventHandler

Event Data

The FieldValueCollapsing event's data class is PivotFieldValueCancelEventArgs. 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 that corresponds to the currently processed column/row header. Inherited from PivotFieldValueEventArgsBase<T>.
Data For internal use. Inherited from PivotFieldValueEventArgsBase<T>.
DataField Gets the data field that specifies the processed value. Inherited from PivotFieldValueEventArgsBase<T>.
Field Gets the field being processed. Inherited from PivotFieldEventArgsBase<T>.
FieldIndex Gets the field position among the visible fields within the header area. Inherited from PivotFieldValueEventArgsBase<T>.
IsCollapsed Gets whether the processed field value is collapsed. Inherited from PivotFieldValueEventArgsBase<T>.
IsColumn Gets whether the field is displayed within the Column Header Area. Inherited from PivotFieldValueEventArgsBase<T>.
IsOthersValue Gets or sets whether the current header corresponds to the "Others" row/column. Inherited from PivotFieldValueEventArgsBase<T>.
Item For internal use. Inherited from PivotFieldValueEventArgsBase<T>.
MaxIndex Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the processed field value. Inherited from PivotFieldValueEventArgsBase<T>.
MinIndex Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the processed field value. Inherited from PivotFieldValueEventArgsBase<T>.
Value Gets the column field or row field value that corresponds to the currently processed column/row header. Inherited from PivotFieldValueEventArgsBase<T>.
ValueType Gets the type of the currently processed header of a column or a row. Inherited from PivotFieldValueEventArgsBase<T>.

Remarks

The FieldValueCollapsing event is raised when attempting to collapse a field value. The field value can be identified using the event's PivotFieldEventArgsBase<T>.Field parameter. If you need to prohibit field value collapsing, set the PivotFieldValueCancelEventArgs.Cancel parameter to true.

See Also