DetailsView.HeaderTemplate Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the user-defined content for the header row in a DetailsView control.

Namespace:   System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

[<BrowsableAttribute(false)>]
[<PersistenceModeAttribute(PersistenceMode.InnerProperty)>]
[<TemplateContainerAttribute(typeof(DetailsView))>]
abstract HeaderTemplate : ITemplate with get, set
[<BrowsableAttribute(false)>]
[<PersistenceModeAttribute(PersistenceMode.InnerProperty)>]
[<TemplateContainerAttribute(typeof(DetailsView))>]
override HeaderTemplate : ITemplate with get, set

Property Value

Type: System.Web.UI.ITemplate

A System.Web.UI.ITemplate that contains the custom content for the header row. The default value is null, which indicates that this property is not set.

The header row is displayed at the top of the DetailsView control when the HeaderText or HeaderTemplate property is set. You can define your own custom user interface (UI) for the header row by using the HeaderTemplate property. To specify a custom template for the header row, first place <HeaderTemplate> tags between the opening and closing tags of the DetailsView control. You can then list the contents of the template between the opening and closing <HeaderTemplate> tags. To control the style of the header row, use the HeaderStyle property. Alternatively, you can simply display text in the header row by setting the HeaderText property instead of this property.

System_CAPS_noteNote

If both the HeaderText and HeaderTemplate properties are set, the HeaderTemplate property takes precedence.

The following code example demonstrates how to use the HeaderTemplate property to create a custom header row.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show: