Share via


TemplateBasedControl.CustomTemplate Property

Gets or sets a custom template.

Namespace:  Microsoft.SharePoint.WebControls
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

<TemplateContainerAttribute(GetType(TemplateBasedControl))> _
<PersistenceModeAttribute(PersistenceMode.InnerProperty)> _
Public Property CustomTemplate As ITemplate
    Get
    Set

Dim instance As TemplateBasedControl
Dim value As ITemplate

value = instance.CustomTemplate

instance.CustomTemplate = value
[TemplateContainerAttribute(typeof(TemplateBasedControl))]
[PersistenceModeAttribute(PersistenceMode.InnerProperty)]
public ITemplate CustomTemplate { get; set; }

Property Value

Type: System.Web.UI.ITemplate
A ITemplate object that renders the control.

Remarks

The CustomTemplate and CustomAlternateTemplate properties are marked with the [PersistenceMode(PersistenceMode.InnerProperty)] attribute. This means that the ITemplate objects that they return are compiled and persist in the TemplateBasedControl object as a nested tag. There are several advantages to using precompiled templates; for example, they can be added to a page in a visual designer such as Microsoft Office SharePoint Designer 2007 or Microsoft Visual Studio 2005 by dragging and dropping them from the designer toolbox. But there are disadvantages also. For more information, see Patterns of Custom Field Rendering, Web User Controls and Web Custom Controls, and PersistenceModeAttribute.

See Also

Reference

TemplateBasedControl Class

TemplateBasedControl Members

Microsoft.SharePoint.WebControls Namespace

Web User Controls and Web Custom Controls

Other Resources

Patterns of Custom Field Rendering

Custom Field Types

Walkthrough: Creating a Custom Field Type