TemplateDefinition Class
Provides properties and methods that define a template element in a Web server control at design time.
Assembly: System.Design (in System.Design.dll)
| Name | Description | |
|---|---|---|
![]() | TemplateDefinition(ControlDesigner, String, Object, String) | Initializes a new instance of the TemplateDefinition class, using the provided designer, template name, template, and property name. |
![]() | TemplateDefinition(ControlDesigner, String, Object, String, Boolean) | Initializes a new instance of the TemplateDefinition class, using the provided designer, template name, template, property name, and whether to limit the template contents to Web server controls. |
![]() | TemplateDefinition(ControlDesigner, String, Object, String, Style) | Initializes a new instance of the TemplateDefinition class, using the provided designer, template name, template, property name, and Style object. |
![]() | TemplateDefinition(ControlDesigner, String, Object, String, Style, Boolean) | Initializes a new instance of the TemplateDefinition class, using the provided designer, template name, template, property name, Style object, and whether to limit content to Web server controls. |
| Name | Description | |
|---|---|---|
![]() | AllowEditing | Gets a value that indicates whether the template should enable editing of its contents. |
![]() | Content | Gets or sets the HTML markup representing the content of the template. |
![]() | Designer | Gets the associated designer component.(Inherited from DesignerObject.) |
![]() | Name | Gets the name of the object.(Inherited from DesignerObject.) |
![]() | Properties | Gets the object's properties.(Inherited from DesignerObject.) |
![]() | ServerControlsOnly | Retrieves a value indicating whether the template should limit content to Web server controls, as set in the TemplateDefinition constructor. This property is read-only. |
![]() | Style | Retrieves the style that should be applied to the template as set in the TemplateDefinition constructor. This property is read-only. |
![]() | SupportsDataBinding | Retrieves or sets a value indicating whether the template supports data binding. |
![]() | TemplatedObject | Retrieves the component in which the template resides. This property is read-only. |
![]() | TemplatePropertyName | Retrieves the property name for the template that the design host should display in the property grid. |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
![]() | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
![]() | GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
![]() | GetService(Type) | Gets a service from the design host, as identified by the provided type.(Inherited from DesignerObject.) |
![]() | GetType() | |
![]() | MemberwiseClone() | |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() ![]() | IServiceProvider.GetService(Type) | For a description of this member, see IServiceProvider.GetService.(Inherited from DesignerObject.) |
The TemplateDefinition class provides a base template definition class that can be inherited from and extended for a control designer to use in providing support for templated controls in a design host such as Visual Studio 2005. A design host uses the properties and methods of the TemplateDefinition class to facilitate creating and editing a template at design time.
The following code example demonstrates how to derive a custom class from the ControlDesigner class. This control designer supports a control with four possible templates.
To try it, add a reference to the System.Design.dll assembly, compile the code, and then, in a design host such as Visual Studio 2005, look at the page in Design view. Select the control, click the action list to select a template to modify, and then use the drag-and-drop feature to move controls into the template.
Imports Microsoft.VisualBasic Imports System Imports System.ComponentModel Imports System.Web.UI Imports System.Web.UI.WebControls Imports System.Web.UI.Design Namespace ASPNet.Design.Samples ' Set an attribute reference to the designer, and define ' the HTML markup that the toolbox will write into the source. <Designer(GetType(TemplateGroupsSampleDesigner)), _ ToolboxData("<{0}:TemplateGroupsSample runat=server></{0}:TemplateGroupsSample>")> _ Public Class TemplateGroupsSample Inherits WebControl Implements INamingContainer ' Field for the templates Private _templates() As ITemplate ' Constructor Public Sub New() ReDim _templates(4) End Sub ' For each template property, set the designer attributes ' so the property does not appear in the property grid, but ' changes to the template are persisted in the control. <Browsable(False), _ PersistenceMode(PersistenceMode.InnerProperty)> _ Public Property Template1() As ITemplate Get Return _templates(0) End Get Set(ByVal Value As ITemplate) _templates(0) = Value End Set End Property <Browsable(False), _ PersistenceMode(PersistenceMode.InnerProperty)> _ Public Property Template2() As ITemplate Get Return _templates(1) End Get Set(ByVal Value As ITemplate) _templates(1) = Value End Set End Property <Browsable(False), _ PersistenceMode(PersistenceMode.InnerProperty)> _ Public Property Template3() As ITemplate Get Return _templates(2) End Get Set(ByVal Value As ITemplate) _templates(2) = Value End Set End Property <Browsable(False), _ PersistenceMode(PersistenceMode.InnerProperty)> _ Public Property Template4() As ITemplate Get Return _templates(3) End Get Set(ByVal Value As ITemplate) _templates(3) = Value End Set End Property Protected Overrides Sub CreateChildControls() ' Instantiate the template inside the panel ' then add the panel to the Controls collection Dim i As Integer For i = 0 To 3 Dim pan As New Panel() _templates(i).InstantiateIn(pan) Me.Controls.Add(pan) Next End Sub End Class ' Designer for the TemplateGroupsSample class Public Class TemplateGroupsSampleDesigner Inherits System.Web.UI.Design.ControlDesigner Private col As TemplateGroupCollection = Nothing Public Overrides Sub Initialize(ByVal Component As IComponent) ' Initialize the base MyBase.Initialize(Component) ' Turn on template editing SetViewFlags(ViewFlags.TemplateEditing, True) End Sub ' Add instructions to the placeholder view of the control Public Overloads Overrides Function GetDesignTimeHtml() As String Return CreatePlaceHolderDesignTimeHtml("Click here and use " & _ "the task menu to edit the templates.") End Function Public Overrides ReadOnly Property TemplateGroups() As TemplateGroupCollection Get If IsNothing(col) Then ' Get the base collection col = MyBase.TemplateGroups ' Create variables Dim tempGroup As TemplateGroup Dim tempDef As TemplateDefinition Dim ctl As TemplateGroupsSample ' Get reference to the component as TemplateGroupsSample ctl = CType(Component, TemplateGroupsSample) ' Create a TemplateGroup tempGroup = New TemplateGroup("Template Set A") ' Create a TemplateDefinition tempDef = New TemplateDefinition(Me, "Template A1", ctl, "Template1", True) ' Add the TemplateDefinition to the TemplateGroup tempGroup.AddTemplateDefinition(tempDef) ' Create another TemplateDefinition tempDef = New TemplateDefinition(Me, "Template A2", ctl, "Template2", True) ' Add the TemplateDefinition to the TemplateGroup tempGroup.AddTemplateDefinition(tempDef) ' Add the TemplateGroup to the TemplateGroupCollection col.Add(tempGroup) ' Create another TemplateGroup and populate it tempGroup = New TemplateGroup("Template Set B") tempDef = New TemplateDefinition(Me, "Template B1", ctl, "Template3", True) tempGroup.AddTemplateDefinition(tempDef) tempDef = New TemplateDefinition(Me, "Template B2", ctl, "Template4", True) tempGroup.AddTemplateDefinition(tempDef) ' Add the TemplateGroup to the TemplateGroupCollection col.Add(tempGroup) End If Return col End Get End Property ' Do not allow direct resizing unless in TemplateMode Public Overrides ReadOnly Property AllowResize() As Boolean Get If Me.InTemplateMode Then Return True Else Return False End If End Get End Property End Class End Namespace
<%@ Page Language="VB" %> <%@ Register TagPrefix="aspSample" Namespace="ASPNet.Design.Samples" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <aspSample:TemplateGroupsSample runat="server" ID="TGSample1"> </aspSample:TemplateGroupsSample> </div> </form> </body> </html>
Available since 2.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
.jpeg?cs-save-lang=1&cs-lang=vb)
.jpeg?cs-save-lang=1&cs-lang=vb)
.jpeg?cs-save-lang=1&cs-lang=vb)
.jpeg?cs-save-lang=1&cs-lang=vb)
.jpeg?cs-save-lang=1&cs-lang=vb)