PivotGridControl.FieldValueDisplayText Event

Enables the display text of individual column and row headers and filter dropdown items to be customized.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v18.1.dll

Declaration

C#

public event PivotFieldDisplayTextEventHandler FieldValueDisplayText

VB.NET

Public Event FieldValueDisplayText As PivotFieldDisplayTextEventHandler

Event Data

The FieldValueDisplayText event's data class is PivotFieldDisplayTextEventArgs. 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. Inherited from PivotFieldValueEventArgsBase<T>.
Data	For internal use. Inherited from PivotFieldValueEventArgsBase<T>.
DataField	Gets the data field that specifies the processed value. Inherited from PivotFieldValueEventArgsBase<T>.
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. Inherited from PivotFieldValueEventArgsBase<T>.
IsCollapsed	Gets whether the processed field value is collapsed. Inherited from PivotFieldValueEventArgsBase<T>.
IsColumn	Gets whether the field is displayed within the Column Header Area. Inherited from PivotFieldValueEventArgsBase<T>.
IsOthersValue	Gets or sets whether the current header corresponds to the “Others” row/column. Inherited from PivotFieldValueEventArgsBase<T>.
IsPopulatingFilterDropdown	Gets whether the current event is called to populate the filter dropdown.
Item	For internal use. Inherited from PivotFieldValueEventArgsBase<T>.
MaxIndex	Gets the maximum row index (for row fields) or column index (for column fields) that corresponds to the processed field value. Inherited from PivotFieldValueEventArgsBase<T>.
MinIndex	Gets the minimum row index (for row fields) or column index (for column fields) that corresponds to the processed field value. Inherited from PivotFieldValueEventArgsBase<T>.
Value	Gets the processed item’s value.
ValueType	Gets the type of the currently processed header of a column or a row. Inherited from PivotFieldValueEventArgsBase<T>.

The event data class exposes the following methods:

Method	Description
ChangeExpandedState()	Changes the expanded state of the field value currently being processed. Inherited from PivotFieldValueEventArgsBase<T>.
CreateDrillDownDataSource()	Returns a list of records that are used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>.
CreateDrillDownDataSource(List<String>)	Returns a list of records that are used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>.
CreateDrillDownDataSource(Int32)	Returns a list of records that are used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>.
CreateDrillDownDataSource(Int32, List<String>)	Returns a list of records that are used to calculate a summary value for the specified cell. Used in OLAP and server mode. Inherited from PivotFieldValueEventArgsBase<T>.
CreateOLAPDrillDownDataSource(Int32, List<String>)	Obsolete. In OLAP mode, returns a list of records used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>.
CreateServerModeDrillDownDataSource(Int32, List<String>)	Obsolete. In server mode, returns a list of records used to calculate a summary value for the specified cell. Inherited from PivotFieldValueEventArgsBase<T>.
GetCellValue(Int32, Int32)	Returns a value displayed in the specified cell. Inherited from PivotFieldValueEventArgsBase<T>.
GetFieldValue(T, Int32)	Returns the specified column or row field value for the cell, addressed by its zero-based index in the Data Area. Inherited from PivotFieldValueEventArgsBase<T>.
GetHigherLevelFields()	Returns the parent field for the field value currently being processed. Inherited from PivotFieldValueEventArgsBase<T>.
GetHigherLevelFieldValue(T)	Returns the value of a specific parent field corresponding to the field value currently being processed. Inherited from PivotFieldValueEventArgsBase<T>.

Remarks

The FieldValueDisplayText event provides the ability to:

• customize the display text of field values, total headers, grand total headers and data field headers. In this case the IsPopulatingFilterDropdown parameter is set to false;
• customize the display text of items within filter dropdowns. In this case the IsPopulatingFilterDropdown parameter 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 will return null. To get the type of the currently processed header use the PivotFieldValueEventArgsBase<T>.ValueType property.

If the FieldValueDisplayText event is fired for an item within a filter dropdown, 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 dropdown’s item assign a custom string to the DisplayText parameter.

It’s also possible to specify the settings used to format field values and the display text within total headers via the PivotGridFieldBase.ValueFormat, PivotGridFieldBase.TotalValueFormat and PivotGridCustomTotalBase.Format properties. So handle the FieldValueDisplayText event if these properties don’t suit your needs.

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

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#

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

VB.NET

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

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.

VB.NET

how-to-avoid-production-of-unnecessary-column-and-merging-of-cells-in-excel-export-e2346/VB/WindowsApplication53/Form1.vb#L78

Private Sub pivotGridControl1_FieldValueDisplayText(ByVal sender As Object, ByVal e As PivotFieldDisplayTextEventArgs) Handles pivotGridControl1.FieldValueDisplayText
    If e.Field IsNot Nothing AndAlso e.Field.Name = "fieldExportHeader" AndAlso e.ValueType = PivotGridValueType.Value Then

how-to-provide-custom-date-time-group-intervals-and-preserve-correct-sort-order-e2726/VB/WindowsApplication21/Form1.vb#L59

Private Sub pivotGridControl1_FieldValueDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PivotFieldDisplayTextEventArgs) Handles pivotGridControl1.FieldValueDisplayText
    If ReferenceEquals(e.Field, fieldCustomMonth) Then

how-to-hide-empty-field-values-columns-rows-e2807/VB/Form1.vb#L83

End Function
Private Sub pivotGridControl1_FieldValueDisplayText(ByVal sender As Object, ByVal e As PivotFieldDisplayTextEventArgs) Handles pivotGridControl1.FieldValueDisplayText
    If Object.ReferenceEquals(e.Field, pivotGridControl1.Fields(PivotHelper.Month)) Then

how-to-hide-particular-rows-and-columns-e2769/VB/Form1.vb#L49

Private Sub pivotGridControl1_FieldValueDisplayText(ByVal sender As Object,
         ByVal e As PivotFieldDisplayTextEventArgs) Handles pivotGridControl1.FieldValueDisplayText
    Dim pivot As PivotGridControl = TryCast(sender, PivotGridControl)

how-to-implement-the-group-filter-for-a-pivotgrid-e2315/VB/Data.vb#L29

End Function
Private Sub pivotGridControl1_FieldValueDisplayText(ByVal sender As Object, ByVal e As PivotFieldDisplayTextEventArgs) Handles pivotGridControl1.FieldValueDisplayText
    If Object.ReferenceEquals(e.Field, fieldMonth) Then