ASPxPivotGrid.CustomCellDisplayText Event
Enables custom display text to be provided for cells displayed within the Data Area.
Namespace: DevExpress.Web.ASPxPivotGrid
Assembly: DevExpress.Web.ASPxPivotGrid.v24.2.dll
NuGet Package: DevExpress.Web
#Declaration
public event PivotCellDisplayTextEventHandler CustomCellDisplayText
#Event Data
The CustomCellDisplayText event's data class is PivotCellDisplayTextEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
Column |
Gets the column custom total which displays the current cell.
Inherited from Pivot |
Column |
Gets the innermost column field which corresponds to the processed cell.
Inherited from Pivot |
Column |
For internal use.
Inherited from Pivot |
Column |
Gets the visual index of the column that contains the processed cell.
Inherited from Pivot |
Column |
Gets the type of column which contains the processed cell.
Inherited from Pivot |
Data |
Gets the data field which identifies the column where the processed cell resides.
Inherited from Pivot |
Display |
Gets or sets the display text for the cell currently being processed. |
Row |
Gets the row custom total which contains the current cell.
Inherited from Pivot |
Row |
Gets the innermost row field that corresponds to the processed cell.
Inherited from Pivot |
Row |
For internal use.
Inherited from Pivot |
Row |
Gets the index of the row that contains the processed cell.
Inherited from Pivot |
Row |
Gets the type of row that contains the processed cell.
Inherited from Pivot |
Summary |
Gets the summary type of the currently processed value.
Inherited from Pivot |
Summary |
Gets the summary value currently being processed.
Inherited from Pivot |
Value |
Gets the processed cell’s value.
Inherited from Pivot |
The event data class exposes the following methods:
Method | Description |
---|---|
Create |
Returns data records used to calculate a summary value for the cell.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns to return.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to return.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the current cell. Allows you to specify the columns and limit the number of records to return.
Inherited from Pivot |
Create |
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.
Inherited from Pivot |
Create |
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.
Inherited from Pivot |
Create |
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.
Inherited from Pivot |
Create |
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.
Inherited from Pivot |
Create |
Returns a summary data source.
Inherited from Pivot |
Get |
Returns the column’s absolute index by its visible index within the current page.
Inherited from Pivot |
Get |
Returns the row’s absolute index by its visible index within the current page.
Inherited from Pivot |
Get |
Returns a cell value calculated against the specified data field.
Inherited from Pivot |
Get |
Returns a cell value by the column and row indexes.
Inherited from Pivot |
Get |
Returns a cell value calculated for the specified column and row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns an array of column fields that correspond to the current cell.
Inherited from Pivot |
Get |
Returns a Column Grand Total value calculated for the current row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a Column Grand Total value calculated for the specified row field values, against the specified data field.
Inherited from Pivot |
Get |
Returns the specified column or row field’s value for the cell, addressed by its zero-based index in the data area.
Inherited from Pivot |
Get |
Returns the value of the specified column or row field that identifies the column/row in which the processed cell resides.
Inherited from Pivot |
Get |
Gets the Grand Total value for the specified field.
Inherited from Pivot |
Get |
Returns the value of the cell in the same row but in the next column.
Inherited from Pivot |
Get |
Returns the value of the cell in the next row.
Inherited from Pivot |
Get |
Returns the value of the cell in the same row but in the previous column.
Inherited from Pivot |
Get |
Returns the value of the cell in the previous row.
Inherited from Pivot |
Get |
Returns an array of the row fields that correspond to the current cell.
Inherited from Pivot |
Get |
Returns a Row Grand Total value calculated for the current column field values, against the specified data field.
Inherited from Pivot |
Get |
Returns a Row Grand Total value calculated for the specified column field values, against the specified data field.
Inherited from Pivot |
Is |
Indicates whether the specified field’s value that represents the row or column header of the processed cell is expanded.
Inherited from Pivot |
Is |
Gets whether the value of the specified column or row field can be retrieved for the current cell by the Pivot |
Is |
Indicates whether the processed data cell resides within the “Others” row/column when the Top X Value feature is enabled.
Inherited from Pivot |
#Remarks
The CustomCellDisplayText event allows customizing the text within data cells. A data cell displays a summary value calculated against a specific Data Field. This field is identified by the event parameter’s PivotCellEventArgsBase<TField, TData, TCustomTotal>.DataField property. The current value and its formatted text representation are specified by the event’s PivotCellEventArgsBase<TField, TData, TCustomTotal>.Value and PivotCellDisplayTextEventArgs.DisplayText properties.
Data cell format settings can be specified via the PivotGridFieldBase.CellFormat, PivotGridFieldBase.GrandTotalCellFormat and PivotGridFieldBase.TotalCellFormat properties.
Use the ASPxPivotGrid.FieldValueDisplayText event or the PivotGridFieldBase.ValueFormat property to customize display text used to represent field values.
#Example
The following example shows how to provide custom text for the ASPxPivotGrid’s cells by handling the ASPxPivotGrid.CustomCellDisplayText
event.
In this example, if a Grand Total value is less than 50 000, ASPxPivotGrid displays the Low value instead. If the value exceeds 100 000, High is displayed; otherwise, Middle.
using System;
using System.Web.UI;
using DevExpress.Web.ASPxPivotGrid;
using DevExpress.XtraPivotGrid;
namespace FormattingViaEvents {
public partial class _Default : Page {
protected void Page_Load(object sender, EventArgs e) {
}
protected void CustomCellDisplayText(object sender, PivotCellDisplayTextEventArgs e) {
if (e.RowValueType != PivotGridValueType.GrandTotal ||
e.ColumnValueType == PivotGridValueType.GrandTotal) return;
if (Convert.ToSingle(e.Value) < 50000)
e.DisplayText = "Low";
else if (Convert.ToSingle(e.Value) > 100000)
e.DisplayText = "High";
else
e.DisplayText = "Middle";
}
}
}