ASPxPivotGrid.FieldValueNotExpanded Event
Occurs in OLAP mode, when an end-user clicks an expand button or selects Expand All from the context menu, and the field value cannot be expanded.
Namespace: DevExpress.Web.ASPxPivotGrid
Assembly: DevExpress.Web.ASPxPivotGrid.v20.2.dll
Declaration
public event PivotFieldStateChangedEventHandler FieldValueNotExpandedPublic Event FieldValueNotExpanded As PivotFieldStateChangedEventHandlerEvent Data
The FieldValueNotExpanded event's data class is PivotFieldStateChangedEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| CustomTotal | Gets a custom total to which the processed field value corresponds. |
| DataField | Gets the data field which identifies the field value. |
| Field | Gets the field being processed. Inherited from PivotFieldEventArgsBase<T>. |
| FieldIndex | Gets the position of the processed field in the header area. |
| IsCollapsed | Indicates whether the processed field value is collapsed. |
| IsColumn | Gets whether the processed field value belongs to a column or row field. |
| 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. |
| 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. |
| ValueType | Gets the type of the currently processed column/row header. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| CreateDrillDownDataSource() | Returns data records associated with the current field value. |
| 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. |
| 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. |
| 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. |
| GetCellValue(Int32, Int32) | Returns the specified cell's value. |
| GetFieldValue(PivotGridField, Int32) | Returns the specified field value. |
| 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. |
Remarks
In OLAP binding mode, when the control is bound to a cube on an OLAP server, the pivot grid does not calculate summaries itself. Instead, it delegates all data management and calculations to the server side. The raw data is not downloaded to the client side - only the results of calculations.
When an end-user clicks an expand button or the Expand All context menu item, the pivot grid queries the server for a list of child field values. If there are no child field values associated with the current field value, the field value cannot be expanded, and the FieldValueNotExpanded event is raised. This event can be handled, for instance, to display a message that informs a user that the field value cannot be expanded.