ASPxPivotGrid.HeaderTemplate Property

Gets or sets a template to display the content of field headers.

Namespace: DevExpress.Web.ASPxPivotGrid

Assembly: DevExpress.Web.ASPxPivotGrid.v20.2.dll

NuGet Package: DevExpress.Web

Declaration

C#

[DefaultValue(null)]
public virtual ITemplate HeaderTemplate { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Overridable Property HeaderTemplate As ITemplate

Property Value

Type	Default	Description
ITemplate	*null*	An object supporting the System.Web.UI.ITemplate interface that contains the custom content for field headers.

Remarks

By creating a template of the HeaderTemplate type, you can define the custom content displayed for all field headers in the ASPxPivotGrid control. The appearance settings used to paint field headers can be specified by the PivotGridStyles.HeaderStyle or PivotGridField.HeaderStyle property.

The content of a particular field header can be defined using the field’s PivotGridField.HeaderTemplate property, which takes precedence over the HeaderTemplate property.

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.

Related GitHub Examples

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

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#

create-header-or-field-value-templates-and-replicate-existing-look-and-feel-e1805/CS/E1805/Default.aspx.cs#L11

protected void Page_Load(object sender, EventArgs e) {
    ASPxPivotGrid1.HeaderTemplate = new HeaderTemplate();
    ASPxPivotGrid1.FieldValueTemplate = new FieldValueTemplate();

how-to-replace-the-default-filter-popup-with-a-custom-one-made-with-aspxgridview-control-e4669/CS/CustomFilterPopup/FilterPopup.ascx.cs#L125

//BindGridView(CurrentField);
PivotGrid.HeaderTemplate = new HeaderTemplate(ThemeName);
PivotGrid.CustomCallback += new PivotCustomCallbackEventHandler(PivotGrid_CustomCallback);

VB.NET

create-header-or-field-value-templates-and-replicate-existing-look-and-feel-e1805/VB/E1805/Default.aspx.vb#L13

Protected Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
    ASPxPivotGrid1.HeaderTemplate = New HeaderTemplate()
    ASPxPivotGrid1.FieldValueTemplate = New FieldValueTemplate()

how-to-replace-the-default-filter-popup-with-a-custom-one-made-with-aspxgridview-control-e4669/VB/CustomFilterPopup/FilterPopup.ascx.vb#L122

'BindGridView(CurrentField);
PivotGrid.HeaderTemplate = New HeaderTemplate(ThemeName)
AddHandler PivotGrid.CustomCallback, AddressOf PivotGrid_CustomCallback