PivotGridCells.GetCellInfo(Int32, Int32) Method

Returns an object that contains information on the specified cell.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.1.dll

Declaration

C#

public PivotCellEventArgs GetCellInfo(
    int columnIndex,
    int rowIndex
)

VB.NET

Public Function GetCellInfo(
    columnIndex As Integer,
    rowIndex As Integer
) As PivotCellEventArgs

Parameters

Name	Type	Description
columnIndex	Int32	A zero-based integer that identifies the visible index of the column.
rowIndex	Int32	A zero-based integer that identifies the visible index of the row.

Returns

Type	Description
PivotCellEventArgs	A PivotCellEventArgs object that contains information on the specified cell.

Remarks

The GetCellInfo method returns a PivotCellEventArgs object that contains information on the specified cell. It specifies the type of the cell, the cell’s value and display text, whether it is focused or selected, etc. It also lets an array of records associated with this cell to be retrieved via the PivotCellEventArgsBase<TField, TData, TCustomTotal>.CreateDrillDownDataSource method.

To identify a cell, pass the indexes of the row and column that contain the cell as the GetCellInfo method parameters. The valid row indexes lie between 0 and PivotGridCells.RowCount - 1. The valid column indexes lie between 0 and PivotGridCells.ColumnCount - 1.

The PivotGridCells.FocusedCell property identifies the indexes of the row and column that contain the focused cell. To get the coordinates of the selected cells, use the PivotGridCells.Selection property.

Use the PivotGridCells.GetFocusedCellInfo method to get information on the focused cell.

Example

The following example demonstrates how to manually copy the display text of the control’s selected cells to the Clipboard. The selected cells are identified by the PivotGridCells.Selection property.

You can also use the PivotGridCells.CopySelectionToClipboard method to copy the selected cells to the Clipboard.

C#

using DevExpress.XtraPivotGrid;

const string CellDelimiter = "\t";
const string LineDelimiter = "\r\n";

void CopyToClipboard(Pivot Grid Control pivotGrid) {
   PivotGridCells cells = pivotGrid.Cells;
   // Get the coordinates of the selected cells.
   Rectangle cellSelection = cells.Selection;
   string result = "";
   // Get the index of the bottommost selected row.
   int maxRow = cellSelection.Y + cellSelection.Height - 1;
   // Get the index of the rightmost selected column.
   int maxColumn = cellSelection.X + cellSelection.Width - 1;
   // Iterate through the selected cells.
   for(int rowIndex = cellSelection.Y; rowIndex <= maxRow; rowIndex++) {
      for(int colIndex = cellSelection.X; colIndex <= maxColumn; colIndex++) {
         // Get the current cell's display text.
         result += cells.GetCellInfo(colIndex, rowIndex).DisplayText;
         if(colIndex < maxColumn) result += CellDelimiter;
      }
      if(rowIndex < maxRow) result += LineDelimiter;
   }
   // Copy the resulting text to the clipboard.
   Clipboard.SetDataObject(result);
}

VB.NET

Imports DevExpress.XtraPivotGrid

Const CellDelimiter As String = vbTab
Const LineDelimiter As String = vbCrLf

Sub CopyToClipboard(ByVal PivotGrid As PivotGridControl)
   Dim cells As PivotGridCells = PivotGrid.Cells
   ' Get the coordinates of the selected cells.
   Dim cellSelection As Rectangle = cells.Selection
   Dim result As String = ""
   ' Get the index of the bottommost selected row.
   Dim maxRow As Integer = cellSelection.Y + cellSelection.Height - 1
   ' Get the index of the rightmost selected column.
   Dim maxColumn As Integer = cellSelection.X + cellSelection.Width - 1
   ' Iterate through the selected cells.
   Dim rowIndex, colIndex As Integer
   For rowIndex = cellSelection.Y To maxRow
      For colIndex = cellSelection.X To maxColumn
         ' Get the current cell's display text.
         result += cells.GetCellInfo(colIndex, rowIndex).DisplayText
         If (colIndex < maxColumn) Then result += CellDelimiter
      Next
      If (rowIndex < maxRow) Then result += LineDelimiter
   Next
   ' Copy the resulting text to the clipboard.
   Clipboard.SetDataObject(result)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetCellInfo(Int32, Int32) method.

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.

C#

how-to-create-a-custom-chart-data-source-e2520/CS/CustomChartDataSourceWin/CustomChartDataSource.cs#L36

for (int row = selection.Top; row < selection.Bottom; row++) {
    object[] data = GetDataFromCell(fPivot.Cells.GetCellInfo(col, row));
    if (data != null)

how-to-create-a-custom-exporter-for-the-pivotgridcontrol-by-using-the-xtrareport-suite-this-e2231/CS/Report_at_Runtime/PivotReportGenerator.cs#L75

{
    PivotCellEventArgs pcea = pivot.Cells.GetCellInfo(i, 0);
    foreach (PivotGridField field in pcea.GetColumnFields())

how-to-implement-sorting-for-a-custom-cell-value-e2149/CS/ImplementSortingforaCustomCellValue/Form1.cs#L106

for(int j = 0; j < rowCount; j++) {
    PivotCellEventArgs info = pivotGridControl1.Cells.GetCellInfo(i, j);
    if(info != null) {

chartcontrol-how-to-display-pivotgrid-cell-details-in-the-tooltip-e1216/CS/Q144348/Form1.cs#L32

PivotGridControl pivot = (PivotGridControl)chart.DataSource;
PivotCellEventArgs info = pivot.Cells.GetCellInfo(coord.CellX , coord.CellY );
PivotSummaryDataSource source = info.CreateSummaryDataSource();

VB.NET

how-to-create-a-custom-chart-data-source-e2520/VB/CustomChartDataSourceWin/CustomChartDataSource.vb#L36

For row As Integer = selection.Top To selection.Bottom - 1
    Dim data() As Object = GetDataFromCell(fPivot.Cells.GetCellInfo(col, row))
    If data IsNot Nothing Then

how-to-create-a-custom-exporter-for-the-pivotgridcontrol-by-using-the-xtrareport-suite-this-e2231/VB/Report_at_Runtime/PivotReportGenerator.vb#L71

For i As Integer = 0 To pivot.Cells.ColumnCount - 1
    Dim pcea As PivotCellEventArgs = pivot.Cells.GetCellInfo(i, 0)
    For Each field As PivotGridField In pcea.GetColumnFields()

how-to-implement-sorting-for-a-custom-cell-value-e2149/VB/ImplementSortingforaCustomCellValue/Form1.vb#L107

For j As Integer = 0 To rowCount - 1
    Dim info As PivotCellEventArgs = pivotGridControl1.Cells.GetCellInfo(i, j)
    If info IsNot Nothing Then

chartcontrol-how-to-display-pivotgrid-cell-details-in-the-tooltip-e1216/VB/Q144348/Form1.vb#L34

Dim pivot As PivotGridControl = CType(chart.DataSource, PivotGridControl)
Dim info As PivotCellEventArgs = pivot.Cells.GetCellInfo(coord.CellX, coord.CellY)
Dim source As PivotSummaryDataSource = info.CreateSummaryDataSource()