PivotGridControl.FieldValueCollapsing Event
Enables you to control whether field values can be collapsed.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.XtraPivotGrid.v24.2.dll
NuGet Package: DevExpress.Win.PivotGrid
#Declaration
public event PivotFieldValueCancelEventHandler FieldValueCollapsing
#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. |
Custom |
Gets the custom total that corresponds to the currently processed column/row header.
Inherited from Pivot |
Data |
This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
Inherited from Pivot |
Data |
Gets the data field that specifies the processed value.
Inherited from Pivot |
Field |
Gets the field being processed.
Inherited from Pivot |
Field |
Gets the field position among the visible fields within the header area.
Inherited from Pivot |
Is |
Gets whether the processed field value is collapsed.
Inherited from Pivot |
Is |
Gets whether the field is displayed within the Column Header Area.
Inherited from Pivot |
Is |
Gets or sets whether the current header corresponds to the “Others” row/column.
Inherited from Pivot |
Item |
For internal use.
Inherited from Pivot |
Max |
Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the processed field value.
Inherited from Pivot |
Min |
Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the processed field value.
Inherited from Pivot |
Value |
Gets the column field or row field value that corresponds to the currently processed column/row header.
Inherited from Pivot |
Value |
Gets the type of the currently processed header of a column or a row.
Inherited from Pivot |
The event data class exposes the following methods:
Method | Description |
---|---|
Change |
Changes the expanded state of the field value currently being processed.
Inherited from Pivot |
Create |
Returns data records that are used to calculate a summary value for the specified cell.
Inherited from Pivot |
Create |
Returns data records that are used to calculate a summary value for the specified cell.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the specified cell in OLAP and server mode.
Inherited from Pivot |
Create |
Returns data records that are used to calculate a summary value for the specified cell.
Inherited from Pivot |
Create |
Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the specified cell.
Inherited from Pivot |
Create |
Obsolete. In server mode, returns a list of records used to calculate a summary value for the specified cell.
Inherited from Pivot |
Get |
Returns a value displayed in the specified cell.
Inherited from Pivot |
Get |
Returns the specified column or row field value for the cell, addressed by its zero-based index in the Data Area.
Inherited from Pivot |
Get |
Returns the parent field for the field value currently being processed.
Inherited from Pivot |
Get |
Returns the value of a specific parent field corresponding to the field value currently being processed.
Inherited from Pivot |
#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.