[Expand]General Information
[Expand]WinForms Controls
[Collapse]ASP.NET Controls and MVC Extensions
 [Expand]Prerequisites
 [Expand]What's Installed
 [Expand]Common Concepts
 [Expand]ASP.NET WebForms Controls
 [Expand]ASP.NET MVC Extensions
 [Expand]Localization
 [Expand]Redistribution and Deployment
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.Data.Linq
  [Expand]DevExpress.Web
  [Expand]DevExpress.Web.ASPxGauges
  [Expand]DevExpress.Web.ASPxGauges.Base
  [Expand]DevExpress.Web.ASPxGauges.Scripts
  [Expand]DevExpress.Web.ASPxHtmlEditor
  [Expand]DevExpress.Web.ASPxHtmlEditor.Localization
  [Expand]DevExpress.Web.ASPxHtmlEditor.Scripts
  [Collapse]DevExpress.Web.ASPxPivotGrid
   [Expand]ASPxPivotCustomizationControl Class
   [Collapse]ASPxPivotGrid Class
     ASPxPivotGrid Members
     ASPxPivotGrid Constructor
    [Expand]ASPxPivotGrid Properties
    [Collapse]ASPxPivotGrid Events
      AddPopupMenuItem Event
      AfterPerformCallback Event
      BeforeGetCallbackResult Event
      BeforeLoadLayout Event
      BeforePerformDataSelect Event
      BeginRefresh Event
      ClientLayout Event
      ControlHierarchyCreated Event
      CustomCallback Event
      CustomCellDisplayText Event
      CustomCellStyle Event
      CustomCellValue Event
      CustomChartDataSourceData Event
      CustomChartDataSourceRows Event
      CustomCustomizationFormSort Event
      CustomFieldSort Event
      CustomFieldValueCells Event
      CustomFilterExpressionDisplayText Event
      CustomFilterPopupItems Event
      CustomGroupInterval Event
      CustomJsProperties Event
      CustomLoadCallbackState Event
      CustomSaveCallbackState Event
      CustomServerModeSort Event
      CustomSummary Event
      CustomUnboundFieldData Event
      DataAreaPopupCreated Event
      DataSourceChanged Event
      EndRefresh Event
      FieldAreaChanged Event
      FieldAreaChanging Event
      FieldAreaIndexChanged Event
      FieldExpandedInFieldGroupChanged Event
      FieldFilterChanged Event
      FieldFilterChanging Event
      FieldPropertyChanged Event
      FieldUnboundExpressionChanged Event
      FieldValueCollapsed Event
      FieldValueCollapsing Event
      FieldValueDisplayText Event
      FieldValueExpanded Event
      FieldValueExpanding Event
      FieldValueNotExpanded Event
      FieldVisibleChanged Event
      FilterControlCustomValueDisplayText Event
      FilterControlOperationVisibility Event
      FilterControlParseValue Event
      GridLayout Event
      GroupFilterChanged Event
      HtmlCellPrepared Event
      HtmlFieldValuePrepared Event
      LayoutUpgrade Event
      OLAPException Event
      OLAPQueryTimeout Event
      PageIndexChanged Event
      PopupMenuCreated Event
      PrefilterCriteriaChanged Event
      QueryException Event
    [Expand]ASPxPivotGrid Methods
   [Expand]ASPxPivotGridExporter Class
   [Expand]ASPxPivotGridPager Class
   [Expand]ASPxPivotGridPopupMenu Class
   [Expand]CustomCustomizationFormSortEventArgs Class
   [Expand]CustomFieldDataEventArgs Class
    CustomFieldDataEventHandler Delegate
   [Expand]CustomizePivotCellEventArgs Class
    CustomizePivotCellEventHandler Delegate
   [Expand]CustomServerModeSortEventArgs Class
   [Expand]FieldValueCell Class
    MenuItemEnum Enumeration
    PagerAlign Enumeration
   [Expand]PivotAddPopupMenuItemEventArgs Class
    PivotAddPopupMenuItemEventHandler Delegate
   [Expand]PivotAreaChangingEventArgs Class
    PivotAreaChangingEventHandler Delegate
   [Expand]PivotAreaStyle Class
   [Expand]PivotCellBaseEventArgs Class
   [Expand]PivotCellDisplayTextEventArgs Class
    PivotCellDisplayTextEventHandler Delegate
   [Expand]PivotCellStyle Class
   [Expand]PivotCellValueEventArgs Class
   [Expand]PivotChartDataSourceRow Class
    PivotCollapsedStateStoreMode Enumeration
    PivotCustomCallbackEventHandler Delegate
   [Expand]PivotCustomCellStyleEventArgs Class
    PivotCustomCellStyleEventHandler Delegate
   [Expand]PivotCustomChartDataSourceDataEventArgs Class
    PivotCustomChartDataSourceDataEventHandler Delegate
   [Expand]PivotCustomChartDataSourceRowsEventArgs Class
    PivotCustomChartDataSourceRowsEventHandler Delegate
   [Expand]PivotCustomFieldValueCellsEventArgs Class
   [Expand]PivotCustomFilterPopupItemsEventArgs Class
   [Expand]PivotCustomGroupIntervalEventArgs Class
   [Expand]PivotCustomizationFormImages Class
   [Expand]PivotDataAreaPopupCreatedEventArgs Class
    PivotDataHeadersDisplayMode Enumeration
   [Expand]PivotFieldDisplayTextEventArgs Class
    PivotFieldDisplayTextEventHandler Delegate
   [Expand]PivotFieldEventArgs Class
    PivotFieldEventHandler Delegate
   [Expand]PivotFieldFilterChangingEventArgs Class
    PivotFieldFilterChangingEventHandler Delegate
   [Expand]PivotFieldPropertyChangedEventArgs Class
    PivotFieldPropertyChangedEventHandler Delegate
   [Expand]PivotFieldStateChangedCancelEventArgs Class
    PivotFieldStateChangedCancelEventHandler Delegate
   [Expand]PivotFieldStateChangedEventArgs Class
    PivotFieldStateChangedEventHandler Delegate
   [Expand]PivotFieldValueEventArgs Class
    PivotFieldValueEventHandler Delegate
   [Expand]PivotFieldValueStyle Class
   [Expand]PivotFilterButtonPanelStyle Class
   [Expand]PivotFilterButtonStyle Class
   [Expand]PivotFilterItemStyle Class
   [Expand]PivotFilterStyle Class
   [Expand]PivotGridCallbackStateEventArgs Class
    PivotGridCallbackStateEventHandler Delegate
   [Expand]PivotGridCellTemplateContainer Class
   [Expand]PivotGridCellTemplateItem Class
   [Expand]PivotGridClientSideEvents Class
   [Expand]PivotGridCustomCallbackEventArgs Class
   [Expand]PivotGridCustomFieldSortEventArgs Class
    PivotGridCustomFieldSortEventHandler Delegate
    PivotGridCustomGroupIntervalEventHandler Delegate
   [Expand]PivotGridCustomSummaryEventArgs Class
    PivotGridCustomSummaryEventHandler Delegate
   [Expand]PivotGridCustomTotal Class
   [Expand]PivotGridCustomTotalCollection Class
   [Expand]PivotGridEmptyAreaTemplateContainer Class
   [Expand]PivotGridField Class
   [Expand]PivotGridFieldCollection Class
   [Expand]PivotGridFieldValueTemplateContainer Class
   [Expand]PivotGridFieldValueTemplateItem Class
   [Expand]PivotGridHeaderTemplateContainer Class
   [Expand]PivotGridImageProperties Class
   [Expand]PivotGridImages Class
   [Expand]PivotGridPagerStyles Class
    PivotGridPopupMenuType Enumeration
    PivotGridResetOptions Enumeration
   [Expand]PivotGridStyles Class
   [Expand]PivotGridWebFieldOptions Class
   [Expand]PivotGridWebGroup Class
   [Expand]PivotGridWebGroupCollection Class
   [Expand]PivotGridWebOptionsBehavior Class
   [Expand]PivotGridWebOptionsChartDataSource Class
   [Expand]PivotGridWebOptionsCustomization Class
   [Expand]PivotGridWebOptionsData Class
   [Expand]PivotGridWebOptionsDataField Class
   [Expand]PivotGridWebOptionsFilter Class
   [Expand]PivotGridWebOptionsLayout Class
   [Expand]PivotGridWebOptionsLoadingPanel Class
   [Expand]PivotGridWebOptionsPager Class
   [Expand]PivotGridWebOptionsView Class
   [Expand]PivotGroupEventArgs Class
    PivotGroupEventHandler Delegate
   [Expand]PivotHeaderStyle Class
   [Expand]PivotHtmlCellPreparedEventArgs Class
    PivotHtmlCellPreparedEventHandler Delegate
   [Expand]PivotHtmlFieldValuePreparedEventArgs Class
    PivotHtmlFieldValuePreparedEventHandler Delegate
   [Expand]PivotOlapExceptionEventArgs Class
    PivotOlapExceptionEventHandler Delegate
   [Expand]PivotPopupMenuCreatedEventArgs Class
   [Expand]PivotQueryExceptionEventArgs Class
    PivotQueryExceptionEventHandler Delegate
    PivotScrollingMode Enumeration
   [Expand]PivotXlsExportOptions Class
   [Expand]PivotXlsxExportOptions Class
   [Expand]WebCustomExportCellEventArgs Class
   [Expand]WebCustomExportFieldValueEventArgs Class
   [Expand]WebCustomExportHeaderEventArgs Class
   [Expand]WebPivotGridOptionsPrint Class
  [Expand]DevExpress.Web.ASPxPivotGrid.Data
  [Expand]DevExpress.Web.ASPxPivotGrid.HtmlControls
  [Expand]DevExpress.Web.ASPxPivotGrid.Scripts
  [Expand]DevExpress.Web.ASPxRichEdit
  [Expand]DevExpress.Web.ASPxRichEdit.Localization
  [Expand]DevExpress.Web.ASPxRichEdit.Scripts
  [Expand]DevExpress.Web.ASPxScheduler
  [Expand]DevExpress.Web.ASPxScheduler.Commands
  [Expand]DevExpress.Web.ASPxScheduler.Commands.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Controls
  [Expand]DevExpress.Web.ASPxScheduler.Dialogs
  [Expand]DevExpress.Web.ASPxScheduler.Drawing
  [Expand]DevExpress.Web.ASPxScheduler.Localization
  [Expand]DevExpress.Web.ASPxScheduler.Reporting
  [Expand]DevExpress.Web.ASPxScheduler.Scripts
  [Expand]DevExpress.Web.ASPxSpellChecker
  [Expand]DevExpress.Web.ASPxSpellChecker.Localization
  [Expand]DevExpress.Web.ASPxSpellChecker.Scripts
  [Expand]DevExpress.Web.ASPxSpreadsheet
  [Expand]DevExpress.Web.ASPxSpreadsheet.Localization
  [Expand]DevExpress.Web.ASPxSpreadsheet.Scripts
  [Expand]DevExpress.Web.ASPxTreeList
  [Expand]DevExpress.Web.ASPxTreeList.Internal
  [Expand]DevExpress.Web.ASPxTreeList.Localization
  [Expand]DevExpress.Web.ASPxTreeList.Scripts
  [Expand]DevExpress.Web.Captcha
  [Expand]DevExpress.Web.Data
  [Expand]DevExpress.Web.Internal
  [Expand]DevExpress.Web.Localization
  [Expand]DevExpress.Web.Mvc
  [Expand]DevExpress.Web.Mvc.BinderSettings
  [Expand]DevExpress.Web.Mvc.Controllers
  [Expand]DevExpress.Web.MVC.Scripts
  [Expand]DevExpress.Web.Mvc.UI
  [Expand]DevExpress.Web.Office
  [Expand]DevExpress.Web.Office.Internal
  [Expand]DevExpress.Web.Rendering
  [Expand]DevExpress.Web.Scripts
  [Expand]DevExpress.XtraCharts.Web
  [Expand]DevExpress.XtraCharts.Web.Designer
  [Expand]DevExpress.XtraCharts.Web.Scripts
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

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.v18.1.dll

Expanded Syntax

Expanded Event Data

The event handler receives an argument of type PivotFieldDisplayTextEventArgs containing data related to this event.

The following PivotFieldDisplayTextEventArgs properties provide information specific to this event.
Property Description
CustomTotal Gets the custom total which the currently processed column/row header corresponds to.
Data For internal use.
DataField Gets the data field that specifies the processed value.
DisplayText Gets or sets the item's display text.
Field
FieldIndex Gets the field position among the visible fields within the header area.
FieldValueItem Gets the information about the field value currently being processed.
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
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.

Expanded 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 DevExpress.XtraPivotGrid.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.

Expanded Example

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

To do this, check the field value type using the DevExpress.XtraPivotGrid.PivotFieldValueEventArgsBase<T>.ValueType event parameter and provide the required display texts using PivotFieldDisplayTextEventArgs.DisplayText.

Expanded See Also

Is this topic helpful?​​​​​​​