ASPxPivotGrid.FieldValueCollapsing Event
Enables you to control whether field values can be collapsed.
Namespace: DevExpress.Web.ASPxPivotGrid
Assembly: DevExpress.Web.ASPxPivotGrid.v25.1.dll
NuGet Package: DevExpress.Web
Declaration
Event Data
The FieldValueCollapsing event's data class is PivotFieldStateChangedCancelEventArgs. 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 a custom total to which the processed field value corresponds. Inherited from PivotFieldStateChangedEventArgs. |
| DataField | Gets the data field which identifies the field value. Inherited from PivotFieldStateChangedEventArgs. |
| Field | Gets the field being processed. Inherited from PivotFieldEventArgsBase<T>. |
| FieldIndex | Gets the position of the processed field in the header area. Inherited from PivotFieldStateChangedEventArgs. |
| IsCollapsed | Indicates whether the processed field value is collapsed. Inherited from PivotFieldStateChangedEventArgs. |
| IsColumn | Gets whether the processed field value belongs to a column or row field. Inherited from PivotFieldStateChangedEventArgs. |
| IsOthersValue | Gets whether the current header corresponds to the “Others” row/column. Inherited from PivotFieldStateChangedEventArgs. |
| 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 PivotFieldStateChangedEventArgs. |
| 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 PivotFieldStateChangedEventArgs. |
| Value | Gets the column field or row field value to which the currently processed column/row header corresponds. Inherited from PivotFieldStateChangedEventArgs. |
| Values | Gets the outer field values in the processed row/column. Inherited from PivotFieldStateChangedEventArgs. |
| ValueType | Gets the type of the currently processed column/row header. Inherited from PivotFieldStateChangedEventArgs. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| CreateDrillDownDataSource() | Returns data records associated with the current field value. Inherited from PivotFieldStateChangedEventArgs. |
| CreateDrillDownDataSource(Int32, List<String>) | Returns data records used to calculate a summary value for the current field. Allows you to specify the columns and limit the number of records to return. Inherited from PivotFieldStateChangedEventArgs. |
| CreateOLAPDrillDownDataSource(Int32, List<String>) | Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the current field. Allows you to specify the columns and limit the number of records to be returned. Inherited from PivotFieldStateChangedEventArgs. |
| CreateServerModeDrillDownDataSource(Int32, List<String>) | Obsolete. In server mode, returns a list of records used to calculate a summary value for the current field. Allows you to specify the columns and limit the number of records to be returned. Inherited from PivotFieldStateChangedEventArgs. |
| GetCellValue(Int32, Int32) | Returns the specified cell’s value. Inherited from PivotFieldStateChangedEventArgs. |
| GetFieldValue(PivotGridField, Int32) | Returns the specified field value. Inherited from PivotFieldStateChangedEventArgs. |
| GetHigherLevelFields() | Returns the parent field(s) for the field value being currently processed. Inherited from PivotFieldStateChangedEventArgs. |
| GetHigherLevelFieldValue(PivotGridField) | Returns the value of a specific parent field corresponding to the field value currently being processed. Inherited from PivotFieldStateChangedEventArgs. |
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. To prohibit field value collapsing, set the PivotFieldStateChangedCancelEventArgs.Cancel parameter to true.
See Also