PivotGridControl.FieldValueDisplayText Event

Enables you to provide custom text displayed within individual field values or filter dropdown items.

Namespace : DevExpress.Xpf.PivotGrid

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

NuGet Package : DevExpress.Wpf.PivotGrid

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 text displayed within column or row headers (field values, totals, grand totals, etc.).

• Customize the text of items displayed within the filter dropdown. In this instance, the event parameter’s PivotFieldDisplayTextEventArgs.IsPopulatingFilterDropdown property is set to true. The Field parameter returns the column, row or filter field whose dropdown has been invoked.

To specify a custom display text for a header or filter window’s item, assign the required string to the PivotFieldDisplayTextEventArgs.DisplayText property.

To learn more, see Custom Formatting.

Note

If a field’s PivotGridField.SortMode property is set to FieldSortMode.DisplayText and the pivot grid is in an Asynchronous Mode, the FieldValueDisplayText event is handled in a background thread. In this instance, you cannot access the PivotFieldEventArgs.Field and PivotFieldValueEventArgs.DataField event parameter’s properties. Use the PivotFieldDisplayTextEventArgs.ThreadSafeField and PivotFieldDisplayTextEventArgs.ThreadSafeDataField properties instead.

Example

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

To do this, check the field value type using the PivotFieldValueEventArgs.ValueType event parameter and provide the required display texts using PivotFieldDisplayTextEventArgs.DisplayText.

• C#
• VB.NET

private void PivotGridControl_FieldValueDisplayText(object sender, DevExpress.Xpf.PivotGrid.PivotFieldDisplayTextEventArgs e) {
    if (e.ValueType == DevExpress.Xpf.PivotGrid.FieldValueType.GrandTotal) {
        if (e.IsColumn)
            e.DisplayText = "*Custom Column Grand Total*";
        else
            e.DisplayText = "*Custom Row Grand Total*";
    }
}

Private Sub PivotGridControl_FieldValueDisplayText(ByVal sender As Object, ByVal e As DevExpress.Xpf.PivotGrid.PivotFieldDisplayTextEventArgs)
    If e.ValueType = DevExpress.Xpf.PivotGrid.FieldValueType.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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FieldValueDisplayText event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

• XAML

wpf-pivot-grid-hide-specific-columns-and-row/CS/WpfApp/MainWindow.xaml#L34

DataProcessingEngine="Optimized"
FieldValueDisplayText="pivotGrid_FieldValueDisplayText"
CustomFieldValueCells="pivotGrid_CustomFieldValueCells">

wpf-pivot-grid-split-field-value-cells/CS/Window1.xaml#L16

<dxpg:PivotGridControl Grid.Row="1" Margin="2,2,2,0" Name="pivotGrid" AllowDrag="False"
                       FieldValueDisplayText="pivotGrid_FieldValueDisplayText"
                       AllowFilter="False" DataProcessingEngine="Optimized"/>

See Also

PivotGridControl Class

PivotGridControl Members

DevExpress.Xpf.PivotGrid Namespace