PivotGridControl.FieldValueExpanded Event
Fires after a field value has been expanded.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.XtraPivotGrid.v19.1.dll
Declaration
Event Data
The FieldValueExpanded event's data class is PivotFieldValueEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| 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>. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| ChangeExpandedState() | Changes the expanded state of the field value currently being processed. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateDrillDownDataSource() | Returns data records that are used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateDrillDownDataSource(List<String>) | Returns data records that are used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateDrillDownDataSource(Int32, List<String>) | Returns data records used to calculate a summary value for the specified cell in OLAP and server mode. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateDrillDownDataSource(Int32) | Returns data records that are used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateOLAPDrillDownDataSource(Int32, List<String>) | Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| CreateServerModeDrillDownDataSource(Int32, List<String>) | Obsolete. In server mode, returns a list of records used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| GetCellValue(Int32, Int32) | Returns a value displayed in the specified cell. Inherited from PivotFieldValueEventArgsBase<T>. |
| GetFieldValue(T, Int32) | Returns the specified column or row field value for the cell, addressed by its zero-based index in the Data Area. Inherited from PivotFieldValueEventArgsBase<T>. |
| GetHigherLevelFields() | Returns the parent field for the field value currently being processed. Inherited from PivotFieldValueEventArgsBase<T>. |
| GetHigherLevelFieldValue(T) | Returns the value of a specific parent field corresponding to the field value currently being processed. Inherited from PivotFieldValueEventArgsBase<T>. |
Remarks
The FieldValueExpanded event is raised after a field value has been expanded by an end user. Note that it provides a notification only and you cannot cancel the action. To control whether individual field values can be expanded, handle the PivotGridControl.FieldValueExpanding event instead.
Note
The PivotGridControl.FieldValueCollapsed and FieldValueExpanded events raise when a single value is expanded or collapsed and do not fire when end users expand / collapse fields by using the built-in context menu. To be notified when an end-user clicks the “Expand All” or “Collapse All” menu items, use the PivotGridControl.PopupMenuShowing event. In this case, you can use the PivotContextMenuIds class to identify menu items.