PivotGridControl.CellDoubleClick Event
Occurs when a cell is double-clicked.
Namespace: DevExpress.XtraPivotGrid
Assembly: DevExpress.XtraPivotGrid.v18.1.dll
Declaration
Event Data
The CellDoubleClick event's data class is PivotCellEventArgs. The following properties provide information specific to this event:
| Property | Description |
|---|---|
| Bounds | Gets the cell’s bounds. |
| ColumnCustomTotal | Gets the column custom total which displays the current cell. |
| ColumnField | Gets the innermost column field which corresponds to the processed cell. |
| ColumnFieldIndex | For internal use. |
| ColumnIndex | Gets the visual index of the column that contains the processed cell. |
| ColumnValueType | Gets the type of column which contains the processed cell. |
| Data | For internal use. |
| DataField | Gets the data field which identifies the column where the processed cell resides. |
| DisplayText | Gets the display text of the cell currently being processed. |
| Focused | Gets whether the processed cell is the focused cell. |
| Item | For internal use. |
| RowCustomTotal | Gets the row custom total which contains the current cell. |
| RowField | Gets the innermost row field which corresponds to the processed cell. |
| RowFieldIndex | For internal use. |
| RowIndex | Gets the index of the row that contains the processed cell. |
| RowValueType | Gets the type of row which contains the processed cell. |
| Selected | Gets whether the processed cell is selected. |
| SummaryType | Gets the summary type of the currently processed value. |
| SummaryValue | Gets the summary value currently being processed. |
| Value | Gets the processed cell’s value. |
The event data class exposes the following methods:
| Method | Description |
|---|---|
| CreateDrillDownDataSource() | Returns a list of records used to calculate a summary value for the cell currently being processed. |
| CreateDrillDownDataSource(List<String>) | Returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns to be returned. |
| CreateDrillDownDataSource(Int32) | Returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to be returned. |
| CreateDrillDownDataSource(Int32, List<String>) | Returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to be returned. |
| CreateOLAPDrillDownDataSource(List<String>) | Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns to be returned. |
| CreateOLAPDrillDownDataSource(Int32, List<String>) | Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to be returned. |
| CreateServerModeDrillDownDataSource(List<String>) | Obsolete. In server mode, returns a list of records used to calculate a summary value for the current cell. Allows you to specify the columns 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 cell. Allows you to specify the columns and limit the number of records to be returned. |
| CreateSummaryDataSource() | Returns a summary data source. |
| GetCellValue(TField) | Returns a cell value calculated against the specified data field. |
| GetCellValue(Int32, Int32) | Returns a cell value by the column and row indexes. |
| GetCellValue(Object[], Object[], TField) | Returns a cell value calculated for the specified column and row field values, against the specified data field. |
| GetColumnFields() | Returns an array of column fields which correspond to the current cell. |
| GetColumnGrandTotal(TField) | Returns a Column Grand Total value calculated for the current row field values, against the specified data field. |
| GetColumnGrandTotal(Object[], TField) | Returns a Column Grand Total value calculated for the specified row field values, against the specified data field. |
| GetFieldValue(TField) | Returns the value of the specified column or row field which identifies the column/row in which the processed cell resides. |
| GetFieldValue(TField, Int32) | Returns the specified column or row field’s value for the cell, addressed by its zero-based index in the data area. |
| GetGrandTotal(TField) | Gets the Grand Total value for the specified field. |
| GetNextColumnCellValue(TField) | Returns the value of the cell in the same row but in the next column. |
| GetNextRowCellValue(TField) | Returns the value of the cell in the next row. |
| GetPrevColumnCellValue(TField) | Returns the value of the cell in the same row but in the previous column. |
| GetPrevRowCellValue(TField) | Returns the value of the cell in the previous row. |
| GetRowFields() | Returns an array of the row fields which correspond to the current cell. |
| GetRowGrandTotal(TField) | Returns a Row Grand Total value calculated for the current column field values, against the specified data field. |
| GetRowGrandTotal(Object[], TField) | Returns a Row Grand Total value calculated for the specified column field values, against the specified data field. |
| IsFieldValueExpanded(TField) | Indicates whether the specified field’s value that represents the row or column header of the processed cell is expanded. |
| IsFieldValueRetrievable(TField) | Gets whether the value of the specified column or row field can be retrieved for the current cell by the PivotCellEventArgsBase<TField, TData, TCustomTotal>.GetFieldValue method. |
| IsOthersFieldValue(TField) | Indicates whether the processed data cell resides within the “Others” row/column when the Top X Value feature is enabled. |
Remarks
This event occurs when any cell within the Data Area is double-clicked. The event’s parameters allows you to identify the row and column in which the processed cell resides, the data field to which the cell corresponds, whether the cell is selected or focused, etc.
Example
The following example shows how to display the records from the control’s underlying data source which correspond to a particular cell. A new form that displays these records is opened when a particular cell in the PivotGrid control is double-clicked.
In the example the PivotGridControl.CellDoubleClick event is handled. The PivotCellEventArgsBase<TField, TData, TCustomTotal>.CreateDrillDownDataSource method is called to obtain the list of records associated with the clicked cell.
The following image shows a sample PivotGrid control which is bound to the Invoices table in the nwind.mdb database:
Clicking the third cell in the 1994 column will invoke the following form:
It lists all the orders made in 1994 by Belgian customers.
using DevExpress.XtraPivotGrid;
private void pivotGridControl1_CellDoubleClick(object sender, PivotCellEventArgs e) {
// Create a new form.
Form form = new Form();
form.Text = "Records";
// Place a DataGrid control on the form.
DataGrid grid = new DataGrid();
grid.Parent = form;
grid.Dock = DockStyle.Fill;
// Get the recrd set associated with the current cell and bind it to the grid.
grid.DataSource = e.CreateDrillDownDataSource();
form.Bounds = new Rectangle(100, 100, 500, 400);
// Display the form.
form.ShowDialog();
form.Dispose();
}
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CellDoubleClick 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.