ASPxPivotGrid.FieldValueDisplayText Event
Enables the display text of individual column and row headers and filter dropdown items to be customized.
Namespace: DevExpress.Web.ASPxPivotGrid
Assembly: DevExpress.Web.ASPxPivotGrid.v24.2.dll
NuGet Package: DevExpress.Web
#Declaration
public event PivotFieldDisplayTextEventHandler FieldValueDisplayText
#Event Data
The FieldValueDisplayText event's data class is PivotFieldDisplayTextEventArgs. The following properties provide information specific to this event:
Property | Description |
---|---|
Custom |
Gets the custom total that corresponds to the currently processed column/row header.
Inherited from Pivot |
Data |
For internal use.
Inherited from Pivot |
Data |
Gets the data field that specifies the processed value.
Inherited from Pivot |
Display |
Gets or sets the item’s display text. |
Field |
Gets the field being processed.
Inherited from Pivot |
Field |
Gets the field position among the visible fields within the header area.
Inherited from Pivot |
Is |
Gets whether the processed field value is collapsed.
Inherited from Pivot |
Is |
Gets whether the field is displayed within the Column Header Area.
Inherited from Pivot |
Is |
Gets or sets whether the current header corresponds to the “Others” row/column.
Inherited from Pivot |
Is |
Gets whether this event is raised to populate the filter dropdown. |
Item |
For internal use.
Inherited from Pivot |
Max |
Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the processed field value.
Inherited from Pivot |
Min |
Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the processed field value.
Inherited from Pivot |
Value | Gets the processed item’s value. |
Value |
Gets the type of the currently processed header of a column or a row.
Inherited from Pivot |
The event data class exposes the following methods:
Method | Description |
---|---|
Change |
Changes the expanded state of the field value currently being processed.
Inherited from Pivot |
Create |
Returns data records that are used to calculate a summary value for the specified cell.
Inherited from Pivot |
Create |
Returns data records that are used to calculate a summary value for the specified cell.
Inherited from Pivot |
Create |
Returns data records used to calculate a summary value for the specified cell in OLAP and server mode.
Inherited from Pivot |
Create |
Returns data records that are used to calculate a summary value for the specified cell.
Inherited from Pivot |
Create |
Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the specified cell.
Inherited from Pivot |
Create |
Obsolete. In server mode, returns a list of records used to calculate a summary value for the specified cell.
Inherited from Pivot |
Get |
Returns a value displayed in the specified cell.
Inherited from Pivot |
Get |
Returns the specified column or row field value for the cell, addressed by its zero-based index in the Data Area.
Inherited from Pivot |
Get |
Returns the parent field for the field value currently being processed.
Inherited from Pivot |
Get |
Returns the value of a specific parent field corresponding to the field value currently being processed.
Inherited from Pivot |
#Remarks
Handle the FieldValueDisplayText event to do the following:
- customize the display text of field values, total headers, grand total headers and data field headers;
- customize the display text of items within filter windows. In this instance, the PivotFieldDisplayTextEventArgs.IsPopulatingFilterDropdown property is set to true.
If the FieldValueDisplayText event is raised for a field value or total header, the Field parameter identifies the corresponding column field or row field. If this event is raised for a data field header, the Field parameter identifies the corresponding data field.
If the FieldValueDisplayText event is raised for a grand total header, the Field property returns null. To get the type of the processed header, use the PivotFieldValueEventArgsBase<T>.ValueType property.
If the FieldValueDisplayText event is fired for an item within a Filter Window, the Field parameter returns the column, row or filter field whose dropdown has been invoked.
To supply custom display text for a header or filter window’s item, assign the custom string to the PivotFieldDisplayTextEventArgs.DisplayText property.
#Example
The ASPxPivotGrid.FieldValueDisplayText
event allows you to customize field value texts for grand totals.
To do this, check the field value type using the PivotFieldValueEventArgsBase<T>.ValueType event parameter and provide the required display texts using PivotFieldDisplayTextEventArgs.DisplayText.
protected void ASPxPivotGrid1_FieldValueDisplayText(object sender, DevExpress.Web.ASPxPivotGrid.PivotFieldDisplayTextEventArgs e) {
if (e.ValueType == DevExpress.XtraPivotGrid.PivotGridValueType.GrandTotal) {
if (e.IsColumn)
e.DisplayText = "*Custom Column Grand Total*";
else
e.DisplayText = "*Custom Row Grand Total*";
}
}