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.v19.2.dll

Declaration

public event PivotFieldDisplayTextEventHandler FieldValueDisplayText
Public Event FieldValueDisplayText As PivotFieldDisplayTextEventHandler

Event Data

The FieldValueDisplayText event handler receives an argument of the PivotFieldDisplayTextEventArgs type. The following properties provide information specific to this event.

Property Description
CustomTotal Gets the custom total that corresponds to the currently processed column/row header.
Data For internal use.
DataField Gets the data field that specifies the processed value.
DisplayText Gets or sets the item's display text.
Field Gets the field being processed.
(Inherited from PivotFieldEventArgsBase<T>)
FieldIndex Gets the field position among the visible fields within the header area.
FieldValueItem Gets the information about the field value currently being processed.
(Inherited from PivotFieldValueEventArgs)
IsCollapsed Gets whether the processed field value is collapsed.
IsColumn Gets whether the field is displayed within the Column Header Area.
IsOthersValue Gets or sets whether the current header corresponds to the "Others" row/column.
IsPopulatingFilterDropdown Gets whether this event is raised to populate the filter dropdown.
Item For internal use.
MaxIndex Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the processed field value.
MinIndex Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the processed field value.
Value Gets the processed item's value.
ValueType Gets the type of the currently processed header of a column or a row.

Remarks

Handle the FieldValueDisplayText event to do the following:

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.

Examples

The ASPxPivotGrid.FieldValueDisplayText event allows you to customize field value texts for grand totals.

AspPivot_GrandTotalCustomText

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