ASPxPivotGrid.FieldValueCollapsed Event
Fires after a field value has been collapsed.
Namespace: DevExpress.Web.ASPxPivotGrid
Assembly: DevExpress.Web.ASPxPivotGrid.v24.2.dll
NuGet Package: DevExpress.Web
#Declaration
public event PivotFieldStateChangedEventHandler FieldValueCollapsed
#Event Data
The FieldValueCollapsed event's data class is PivotFieldStateChangedEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
Custom |
Gets a custom total to which the processed field value corresponds. |
Data |
Gets the data field which identifies the field value. |
Field |
Gets the field being processed.
Inherited from Pivot |
Field |
Gets the position of the processed field in the header area. |
Is |
Indicates whether the processed field value is collapsed. |
Is |
Gets whether the processed field value belongs to a column or row field. |
Is |
Gets whether the current header corresponds to the “Others” row/column. |
Max |
Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the field value currently being processed. |
Min |
Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the field value currently being processed. |
Value | Gets the column field or row field value to which the currently processed column/row header corresponds. |
Values | Gets the outer field values in the processed row/column. |
Value |
Gets the type of the currently processed column/row header. |
The event data class exposes the following methods:
Method | Description |
---|---|
Create |
Returns data records associated with the current field value. |
Create |
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. |
Create |
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. |
Create |
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. |
Get |
Returns the specified cell’s value. |
Get |
Returns the specified field value. |
Get |
Returns the parent field |
Get |
Returns the value of a specific parent field corresponding to the field value currently being processed. |
#Remarks
The FieldValueCollapsed event is raised after a field value has been collapsed by an end-user. This event only provides a notification, and you cannot cancel the action. To control whether individual field values can be collapsed, handle the ASPxPivotGrid.FieldValueCollapsing event instead.