TemplateBasedControl Class (Microsoft.SharePoint.WebControls)

Switch on low bandwidth view

Community Content

In this section

Statistics Annotations (0)

Click here to expand

Collapse All

Language Filter

TemplateBasedControl Class (Microsoft.SharePoint.WebControls)

Represents a control that is defined by a template rather than by the schema of the list.

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

Syntax

Visual Basic (Declaration)

<PersistChildrenAttribute(False)> _
<ParseChildrenAttribute(True)> _
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel:=True)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level:=AspNetHostingPermissionLevel.Minimal)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel:=True)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class TemplateBasedControl
    Inherits SPControl
    Implements INamingContainer

Visual Basic (Usage)

Dim instance As TemplateBasedControl

[PersistChildrenAttribute(false)] 
[ParseChildrenAttribute(true)] 
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel=true)] 
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level=AspNetHostingPermissionLevel.Minimal)] 
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel=true)] 
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level=AspNetHostingPermissionLevel.Minimal)] 
public class TemplateBasedControl : SPControl, INamingContainer

Remarks

Use this class (or one of its derived classes) as a base for deriving specific types of template-rendered controls. You can use an existing template that is included with Windows SharePoint Services 3.0 or create your own.

Templates are objects of type ITemplate. Typically they serve as the value of the RenderingTemplate.Template property. RenderingTemplate objects are defined in .ascx files located in the following folder:

C:\program files\common files\microsoft shared\web server extensions\12\template\controltemplates

Inheritance Hierarchy

System.Object
   System.Web.UI.Control
     Microsoft.SharePoint.WebControls.SPControl
      Microsoft.SharePoint.WebControls.TemplateBasedControl
         Derived Classes

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

TemplateBasedControl Members
Microsoft.SharePoint.WebControls Namespace

Other Resources

Patterns of Custom Field Rendering
Custom Field Types
Walkthrough: Creating a Custom Field Type