PivotGridControl.FieldValueDisplayText Event

Allows you to change the display text and display field’s data in a more user-friendly format.

Namespace : DevExpress.XtraPivotGrid

Assembly : DevExpress.XtraPivotGrid.v25.2.dll

NuGet Package : DevExpress.Win.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

Check the Display Text Event option in the following demo:

Run Demo: XtraPivotGrid MainDemo — Calculated Fields

Do not call the e.CreateDrillDownDataSource method in the FieldValueDisplayText handler. It can return null in certain cases (sorting, filter popup) or cause other issues.

The following table illustrates event data supplied for different visual elements that trigger the FieldValueDisplayText event.

To specify a text to display, assign a string to the PivotFieldDisplayTextEventArgs.DisplayText property. You can use HTML formatting, as illustrated in the HTML in Field Values live example available in our demo center.

To display field values instead of automatically created and formatted strings, use the following code:

• C#
• VB.NET

e.DisplayText = e.Value?.ToString()

e.DisplayText = If(e.Value Is Nothing, Nothing, e.Value.ToString())

Use the PivotGridControl.CustomCellDisplayText event or PivotGridFieldBase.CellFormat property to customize the display text of cells in the Data area.

Important

Do not change cell values, modify the control’s layout, or change the control’s object model in the events used for custom control painting. Actions that update the layout can cause the control to malfunction.

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 PivotFieldValueEventArgsBase<T>.ValueType event parameter and provide the required display texts using PivotFieldDisplayTextEventArgs.DisplayText.

• C#
• VB.NET

private void pivotGridControl1_FieldValueDisplayText(object sender, DevExpress.XtraPivotGrid.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*";
    }
}

Private Sub pivotGridControl1_FieldValueDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.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

More Examples

View Example: How to Hide Empty Field Values (Columns/Rows)

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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.

• C#
• VB.NET

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/CS/PivotGridCustomSummaryExample/Form1.cs#L13

SelectCustomSummaryApproach(pivotGridControl1.OptionsData.DataProcessingEngine);
pivotGridControl1.FieldValueDisplayText += PivotGridControl1_FieldValueDisplayText;
pivotGridControl1.DataSource = TestData.GetData();

winforms-pivotgrid--display-the-difference-of-income-and-outlay-in-totals/VB/PivotGridCustomSummaryExample/Form1.vb#L12

SelectCustomSummaryApproach(pivotGridControl1.OptionsData.DataProcessingEngine)
AddHandler pivotGridControl1.FieldValueDisplayText, AddressOf PivotGridControl1_FieldValueDisplayText
pivotGridControl1.DataSource = TestData.GetData()

See Also

CustomCellDisplayText

ValueFormat

PivotGridControl Class

PivotGridControl Members

DevExpress.XtraPivotGrid Namespace