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

NuGet Package : DevExpress.Web

Declaration

• C#
• VB.NET

public event PivotFieldDisplayTextEventHandler FieldValueDisplayText

Public Event FieldValueDisplayText As PivotFieldDisplayTextEventHandler

Event Data

The FieldValueDisplayText event's data class is PivotFieldDisplayTextEventArgs. The following properties provide information specific to this event:

The event data class exposes the following methods:

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.

• C#
• VB.NET

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

Protected Sub ASPxPivotGrid1_FieldValueDisplayText(ByVal sender As Object, ByVal e As DevExpress.Web.ASPxPivotGrid.PivotFieldDisplayTextEventArgs)
    If e.ValueType = DevExpress.XtraPivotGrid.PivotGridValueType.GrandTotal Then
        If e.IsColumn Then
            e.DisplayText = "*Custom Column Grand Total*"
        Else
            e.DisplayText = "*Custom Row Grand Total*"
        End If
    End If
End Sub

See Also

CustomCellDisplayText

ASPxPivotGrid Class

ASPxPivotGrid Members

DevExpress.Web.ASPxPivotGrid Namespace