PivotGridControl.Cells Property

Gets the object which contains information on the cells that are displayed by the control.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v20.1.dll

Declaration

[Browsable(false)]
public PivotGridCells Cells { get; }
<Browsable(False)>
Public ReadOnly Property Cells As PivotGridCells

Property Value

Type Description
PivotGridCells

A PivotGridCells object which contains information on the data cells.

Remarks

This property allows you to get view information on the cells displayed by the PivotGrid control (the number of columns, rows, the coordinates of the focused and selected cells).

The PivotGridCells.GetCellInfo method can be used to get information specific to particular cells. For instance, it's possible to determine the type of a specific cell, the cell's value and display text or get a list of the records which are associated with this cell.

Examples

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.

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);
}
See Also