[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
   [Expand]ASPxPivotGrid Class
   [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
   [Collapse]PivotGridField Class
     PivotGridField Members
    [Expand]PivotGridField Constructor
    [Collapse]PivotGridField Properties
      AllowedAreas Property
      Calculations Property
      CellStyle Property
      CustomTotals Property
      DeferFilterButtonImage Property
      ExportBestFit Property
      FieldName Property
      FilterButtonImage Property
      GroupIndex Property
      HeaderStyle Property
      HeaderTemplate Property
      ID Property
      InnerGroupIndex Property
      IsTextOnly Property
      MinWidth Property
      Name Property
      Options Property
      OptionsFilter Property
      SortImage Property
      ValueStyle Property
      ValueTemplate Property
      ValueTotalStyle Property
      Width Property
    [Expand]PivotGridField Methods
   [Expand]PivotGridFieldCollection Class
   [Expand]PivotGridFieldValueTemplateContainer Class
   [Expand]PivotGridFieldValueTemplateItem Class
    PivotGridHeaderFilterListBoxSearchUIVisibility Enumeration
   [Expand]PivotGridHeaderTemplateContainer Class
   [Expand]PivotGridImageProperties Class
   [Expand]PivotGridImages Class
   [Expand]PivotGridPagerStyles Class
    PivotGridPopupMenuType Enumeration
    PivotGridResetOptions Enumeration
   [Expand]PivotGridStyles Class
   [Expand]PivotGridWebFieldOptions Class
   [Expand]PivotGridWebFieldOptionsFilter 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]PivotOlapQueryDataEventArgs Class
   [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]eXpress Persistent Objects
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation
View this topic on docs.devexpress.com (Learn more)

PivotGridField.HeaderTemplate Property

Gets or sets a template used to display the content of the field's header.

Namespace:DevExpress.Web.ASPxPivotGrid
Assembly:DevExpress.Web.ASPxPivotGrid.v18.2.dll

Expanded Syntax

Property value

Type: ITemplate
An object that supports the System.Web.UI.ITemplate interface and contains the custom content for the field's header.
The default is null.

Expanded Remarks

By creating a template of the HeaderTemplate type, you can define the custom content displayed for the header of the current field. Depending upon a field's DevExpress.XtraPivotGrid.PivotGridFieldBase.Area property setting, its header can be located in the following areas: the column header area, data header area, filter header area, row header area. The appearance of the field header is controlled by the PivotGridStyles.HeaderStyle or HeaderStyle property.

A template created using the HeaderTemplate property takes precedence over a template of the ASPxPivotGrid.HeaderTemplate type, which defines a common content for all field headers within the ASPxPivotGrid control.

Important

Note that the field's ID property must be set to a unique value to use templates.

Note

Once a template defined via the HeaderTemplate property is created within a control, it is instantiated within a container object of the PivotGridHeaderTemplateContainer type. This container object exposes a set of specific properties to which the template's child controls can be bound.

Expanded See Also

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