PivotGridControl.FieldValueExpanded Event
Fires after a field value has been expanded.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.XtraPivotGrid.v18.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 which the currently processed column/row header corresponds to. |
| Data | This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. |
| DataField | Gets the data field that specifies the processed value. |
| Field | Gets the field being processed. Inherited from PivotFieldEventArgsBase<T>. |
| FieldIndex | Gets the field position among the visible fields within the header area. |
| IsCollapsed | Gets whether the processed field value is collapsed. |
| IsColumn | Gets whether the field is displayed within the Column Header Area. |
| IsOthersValue | Gets or sets whether the current header corresponds to the “Others” row/column. |
| Item | For internal use. |
| MaxIndex | Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the processed field value. |
| MinIndex | Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the processed field value. |
| Value | Gets the column field or row field value that corresponds to the currently processed column/row header. |
| ValueType | Gets the type of the currently processed header of a column or a row. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| ChangeExpandedState() | Changes the expanded state of the field value currently being processed. |
| CreateDrillDownDataSource() | Returns a list of records that are used to calculate a summary value for the specified cell. |
| CreateDrillDownDataSource(List<String>) | Returns a list of records that are used to calculate a summary value for the specified cell. |
| CreateDrillDownDataSource(Int32) | Returns a list of records that are used to calculate a summary value for the specified cell. |
| CreateDrillDownDataSource(Int32, List<String>) | Returns a list of records that are used to calculate a summary value for the specified cell. Used in OLAP and server mode. |
| CreateOLAPDrillDownDataSource(Int32, List<String>) | Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the specified cell. |
| CreateServerModeDrillDownDataSource(Int32, List<String>) | Obsolete. In server mode, returns a list of records used to calculate a summary value for the specified cell. |
| GetCellValue(Int32, Int32) | Returns a value displayed in the specified cell. |
| GetFieldValue(T, Int32) | Returns the specified column or row field value for the cell, addressed by its zero-based index in the Data Area. |
| GetHigherLevelFields() | Returns the parent field for the field value currently being processed. |
| GetHigherLevelFieldValue(T) | Returns the value of a specific parent field corresponding to the field value currently being processed. |
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.
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the FieldValueExpanded event.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.