PivotCustomDrawBaseThreadSafeEventArgs.GetCellDisplayText(Int32, Int32) Method

Returns the text displayed in the specified cell.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v23.2.dll

NuGet Package: DevExpress.Win.PivotGrid

Declaration

C#

public string GetCellDisplayText(
    int columnIndex,
    int rowIndex
)

VB.NET

Public Function GetCellDisplayText(
    columnIndex As Integer,
    rowIndex As Integer
) As String

Parameters

Name	Type	Description
columnIndex	Int32	A zero-based integer value that specifies the index of the column where the cell resides.
rowIndex	Int32	A zero-based integer value that specifies the index of the row where the cell resides.

Returns

Type	Description
String	A String that specifies the text displayed in the specified cell.

Remarks

The GetCellDisplayText method is in effect only for cells that have already been displayed. Their display text is contained in the pivot grid cache and can be accessed while the background calculations are being performed. For other cells, the GetCellDisplayText method returns null (Nothing in Visual Basic).

If the specified column or row index is out of range, an exception is thrown. To obtain the number of columns and rows displayed in the pivot grid, use the PivotCustomDrawBaseThreadSafeEventArgs.ColumnCount and PivotCustomDrawBaseThreadSafeEventArgs.RowCount properties respectively.

To obtain the display representation of a field value, use the PivotCustomDrawBaseThreadSafeEventArgs.GetFieldValueDisplayText method.