TemplateDefinition 類別

參考

定義

命名空間:: System.Web.UI.Design

組件:: System.Design.dll

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

提供在設計階段定義 Web 伺服器控制項中樣板項目的屬性和方法。

public ref class TemplateDefinition : System::Web::UI::Design::DesignerObject

public class TemplateDefinition : System.Web.UI.Design.DesignerObject

type TemplateDefinition = class
    inherit DesignerObject

Public Class TemplateDefinition
Inherits DesignerObject

繼承: Object

DesignerObject
TemplateDefinition

範例

下列程式代碼範例示範如何從 ControlDesigner 類別衍生自定義類別。此控件設計工具支援具有四個可能範本的控制件。

若要嘗試，請將參考新增至 System.Design.dll 元件、編譯程式代碼，然後在Visual Studio 2005等設計主機中，查看 [設計] 檢視中的頁面。選取控件，按兩下動作清單以選取要修改的範本，然後使用拖放功能將控件移至範本。

using System;
using System.ComponentModel;
using System.Web.UI;
using System.Web.UI.WebControls;
using 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(typeof(TemplateGroupsSampleDesigner)),
        ToolboxData("<{0}:TemplateGroupsSample runat=server></{0}:TemplateGroupsSample>")]
    public sealed class TemplateGroupsSample : WebControl, INamingContainer
    {
        // Field for the templates
        private ITemplate[] _templates;

        // Constructor
        public TemplateGroupsSample()
        {
            _templates = new ITemplate[4];
        }

        // 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 ITemplate Template1
        {
            get { return _templates[0]; }
            set { _templates[0] = value; }
        }
        [Browsable(false),
            PersistenceMode(PersistenceMode.InnerProperty)]
        public ITemplate Template2
        {
            get { return _templates[1]; }
            set { _templates[1] = value; }
        }
        [Browsable(false),
            PersistenceMode(PersistenceMode.InnerProperty)]
        public ITemplate Template3
        {
            get { return _templates[2]; }
            set { _templates[2] = value; }
        }
        [Browsable(false),
            PersistenceMode(PersistenceMode.InnerProperty)]
        public ITemplate Template4
        {
            get { return _templates[3]; }
            set { _templates[3] = value; }
        }

        protected override void CreateChildControls()
        {
            // Instantiate each template inside a panel
            // then add the panel to the Controls collection
            for (int i = 0; i < 4; i++)
            {
                Panel pan = new Panel();
                _templates[i].InstantiateIn(pan);
                this.Controls.Add(pan);
            }
        }
    }

    // Designer for the TemplateGroupsSample control
    public class TemplateGroupsSampleDesigner : ControlDesigner
    {
        TemplateGroupCollection col = null;

        public override void Initialize(IComponent component)
        {
            // Initialize the base
            base.Initialize(component);
            // Turn on template editing
            SetViewFlags(ViewFlags.TemplateEditing, true);
        }

        // Add instructions to the placeholder view of the control
        public override string GetDesignTimeHtml()
        {
            return CreatePlaceHolderDesignTimeHtml("Click here and use " +
                "the task menu to edit the templates.");
        }

        public override TemplateGroupCollection TemplateGroups
        {
            get
            {

                if (col == null)
                {
                    // Get the base collection
                    col = base.TemplateGroups;

                    // Create variables
                    TemplateGroup tempGroup;
                    TemplateDefinition tempDef;
                    TemplateGroupsSample ctl;

                    // Get reference to the component as TemplateGroupsSample
                    ctl = (TemplateGroupsSample)Component;

                    // Create a TemplateGroup
                    tempGroup = new TemplateGroup("Template Set A");

                    // Create a TemplateDefinition
                    tempDef = new TemplateDefinition(this, "Template A1", 
                        ctl, "Template1", true);

                    // Add the TemplateDefinition to the TemplateGroup
                    tempGroup.AddTemplateDefinition(tempDef);

                    // Create another TemplateDefinition
                    tempDef = new TemplateDefinition(this, "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(this, "Template B1", 
                        ctl, "Template3", true);
                    tempGroup.AddTemplateDefinition(tempDef);
                    tempDef = new TemplateDefinition(this, "Template B2", 
                        ctl, "Template4", true);
                    tempGroup.AddTemplateDefinition(tempDef);

                    // Add the TemplateGroup to the TemplateGroupCollection
                    col.Add(tempGroup);
                }

                return col;
            }
        }

        // Do not allow direct resizing unless in TemplateMode
        public override bool AllowResize
        {
            get
            {
                if (this.InTemplateMode)
                    return true;
                else
                    return false;
            }
        }
    }
}

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>

備註

類別 TemplateDefinition 提供基底範本定義類別，可繼承和擴充控件設計工具，以在設計主機中提供樣板化控件的支援，例如Visual Studio 2005。設計主機會使用類別的屬性 TemplateDefinition 和方法，在設計時間協助建立和編輯範本。

建構函式

TemplateDefinition(ControlDesigner, String, Object, String)	使用所提供的設計工具、樣板名稱、樣板和屬性名稱，初始化 TemplateDefinition 類別的新執行個體。
TemplateDefinition(ControlDesigner, String, Object, String, Boolean)	使用所提供的設計工具、樣板名稱、樣板、屬性名稱和是否將樣板內容限制為 Web 伺服器控制項，初始化 TemplateDefinition 類別的新執行個體。
TemplateDefinition(ControlDesigner, String, Object, String, Style)	使用所提供的設計工具、樣板名稱、樣板、屬性名稱和 TemplateDefinition 物件，初始化 Style 類別的新執行個體。
TemplateDefinition(ControlDesigner, String, Object, String, Style, Boolean)	使用所提供的設計工具、樣板名稱、樣板、屬性名稱、TemplateDefinition 物件和是否將內容限制為 Web 伺服器控制項，初始化 Style 類別的新執行個體。

屬性

AllowEditing	取得值，這個值表示樣板是否應允許編輯其內容。
Content	取得或設定 HTML 標記，表示樣板的內容。
Designer	取得關聯的設計工具元件。 (繼承來源 DesignerObject)
Name	取得物件的名稱。 (繼承來源 DesignerObject)
Properties	取得物件的屬性。 (繼承來源 DesignerObject)
ServerControlsOnly	擷取值，指出樣板是否應將內容限制為 Web 伺服器控制項 (如同 TemplateDefinition 建構函式 (Constructor) 所設定)。這個屬性是唯讀的。
Style	擷取樣式，該樣式應套用至樣板 (如同 TemplateDefinition 建構函式所設定)。這個屬性是唯讀的。
SupportsDataBinding	擷取或設定值，指出樣板是否支援資料繫結 (Data Binding)。
TemplatedObject	擷取樣板所在的元件。這個屬性是唯讀的。
TemplatePropertyName	擷取設計主應用程式應在屬性方格中顯示之樣板的屬性名稱。

方法

Equals(Object)	判斷指定的物件是否等於目前的物件。 (繼承來源 Object)
GetHashCode()	做為預設雜湊函式。 (繼承來源 Object)
GetService(Type)	從設計主應用程式取得服務，由所提供的型別識別。 (繼承來源 DesignerObject)
GetType()	取得目前執行個體的 Type。 (繼承來源 Object)
MemberwiseClone()	建立目前 Object 的淺層複製。 (繼承來源 Object)
ToString()	傳回代表目前物件的字串。 (繼承來源 Object)

明確介面實作

IServiceProvider.GetService(Type)

如需這個成員的說明，請參閱 GetService(Type)。

(繼承來源 DesignerObject)

擴充方法

GetKeyedService<T>(IServiceProvider, Object)	從IServiceProvider取得型`T`別的服務。
GetKeyedServices(IServiceProvider, Type, Object)	從IServiceProvider取得型`serviceType`別服務的列舉。
GetKeyedServices<T>(IServiceProvider, Object)	從IServiceProvider取得型`T`別服務的列舉。
GetRequiredKeyedService(IServiceProvider, Type, Object)	從IServiceProvider取得型`serviceType`別的服務。
GetRequiredKeyedService<T>(IServiceProvider, Object)	從IServiceProvider取得型`T`別的服務。
CreateAsyncScope(IServiceProvider)	建立可用來解析已設定範圍服務的新 AsyncServiceScope。
CreateScope(IServiceProvider)	建立可用來解析已設定範圍服務的新 IServiceScope。
GetRequiredService(IServiceProvider, Type)	從 IServiceProvider 取得 `serviceType` 類型的服務。
GetRequiredService<T>(IServiceProvider)	從 IServiceProvider 取得 `T` 類型的服務。
GetService<T>(IServiceProvider)	從 IServiceProvider 取得 `T` 類型的服務。
GetServices(IServiceProvider, Type)	從 IServiceProvider 取得類型 `serviceType` 服務的列舉。
GetServices<T>(IServiceProvider)	從 IServiceProvider 取得類型 `T` 服務的列舉。
GetFakeLogCollector(IServiceProvider)	取得對象，這個物件會收集傳送至假記錄器的記錄檔記錄。
GetFakeRedactionCollector(IServiceProvider)	從相依性插入容器取得假的重構函式收集器實例。

適用於

共用方式為

TemplateDefinition 類別

定義

範例

備註

建構函式

屬性

方法

明確介面實作

擴充方法

適用於

另請參閱

其他資源