PivotGridControl.CustomCellDisplayText Event

Enables custom display text to be provided for summary cells.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v14.2.dll

Declaration

C#

public event PivotCellDisplayTextEventHandler CustomCellDisplayText

VB.NET

Public Event CustomCellDisplayText As PivotCellDisplayTextEventHandler

Event Data

The CustomCellDisplayText event's handler receives an argument of the PivotCellDisplayTextEventArgs type. The following properties provide information specific to this event:

Property	Description
ColumnCustomTotal	Gets the custom total to which the processed cell's column corresponds. Inherited from PivotCellBaseEventArgs.
ColumnField	Gets the innermost column field which corresponds to the processed cell. Inherited from PivotCellBaseEventArgs.
ColumnFieldIndex	This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from PivotCellBaseEventArgs.
ColumnIndex	Gets the visual index of the column that contains the processed cell. Inherited from PivotCellBaseEventArgs.
ColumnValueType	Gets the type of the cell's column header. Inherited from PivotCellBaseEventArgs.
DataField	Gets the data field which identifies the column where the processed cell resides. Inherited from PivotCellBaseEventArgs.
DisplayText	Gets or sets the display text for the cell currently being processed.
Focused	Gets whether the processed cell is the focused cell. Inherited from PivotCellBaseEventArgs.
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
RowCustomTotal	Gets the custom total to which the processed cell's row corresponds. Inherited from PivotCellBaseEventArgs.
RowField	Gets the innermost row field which corresponds to the processed cell. Inherited from PivotCellBaseEventArgs.
RowFieldIndex	This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from PivotCellBaseEventArgs.
RowIndex	Gets the visual index of the row that contains the processed cell. Inherited from PivotCellBaseEventArgs.
RowValueType	Gets the type of the cell's row header. Inherited from PivotCellBaseEventArgs.
Selected	Gets whether the processed cell is selected. Inherited from PivotCellBaseEventArgs.
Source	Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.
SummaryType	Gets the type of summary calculated in the current cell. Inherited from PivotCellBaseEventArgs.
SummaryValue	Gets the summary value currently being processed. Inherited from PivotCellBaseEventArgs.
Value	Gets the processed cell's value. Inherited from PivotCellBaseEventArgs.

Remarks

Cells display summary values calculated against data fields. Fields provide properties allowing you to specify formatting settings applied to their cells: PivotGridField.CellFormat, PivotGridField.TotalCellFormat and PivotGridField.GrandTotalCellFormat.

Handle the CustomCellDisplayText event to manually customize the text displayed within cells. The event parameter provides properties allowing you to identify the processed cell. To specify a custom display text for a cell, use the PivotCellDisplayTextEventArgs.DisplayText property.

To learn more, see Custom Formatting.