TemplateDefinition Clase

Definición

Espacio de nombres:

System.Web.UI.Design

Ensamblado:

System.Design.dll

Proporciona métodos y propiedades que definen un elemento de plantilla en un control de servidor Web en tiempo de diseño.

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

Herencia

Object

DesignerObject

TemplateDefinition

Ejemplos

En el ejemplo de código siguiente se muestra cómo derivar una clase personalizada de la ControlDesigner clase . Este diseñador de controles admite un control con cuatro plantillas posibles.

Para probarlo, agregue una referencia al ensamblado de System.Design.dll, compile el código y, a continuación, en un host de diseño como Visual Studio 2005, examine la página en la vista Diseño. Seleccione el control, haga clic en la lista de acciones para seleccionar una plantilla que desea modificar y, a continuación, use la característica de arrastrar y colocar para mover los controles a la plantilla.

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>

Comentarios

La TemplateDefinition clase proporciona una clase de definición de plantilla base que se puede heredar y ampliar para que un diseñador de controles se use para proporcionar compatibilidad con controles con plantilla en un host de diseño como Visual Studio 2005. Un host de diseño usa las propiedades y métodos de la TemplateDefinition clase para facilitar la creación y edición de una plantilla en tiempo de diseño.

Constructores

TemplateDefinition(ControlDesigner, String, Object, String)	Inicializa una nueva instancia de la clase TemplateDefinition utilizando el diseñador, el nombre de la plantilla, la plantilla y el nombre de propiedad especificados.
TemplateDefinition(ControlDesigner, String, Object, String, Boolean)	Inicializa una nueva instancia de la clase TemplateDefinition utilizando el diseñador, el nombre de la plantilla, la plantilla y el nombre de propiedad especificados y define si el contenido de la plantilla debe limitarse a controles de servidor web.
TemplateDefinition(ControlDesigner, String, Object, String, Style)	Inicializa una nueva instancia de la clase TemplateDefinition utilizando el diseñador, el nombre de la plantilla, la plantilla, el nombre de propiedad y el objeto Style especificados.
TemplateDefinition(ControlDesigner, String, Object, String, Style, Boolean)	Inicializa una nueva instancia de la clase TemplateDefinition utilizando el diseñador, el nombre de la plantilla, la plantilla, el nombre de propiedad y el objeto Style especificados y define si el contenido debe limitarse a controles de servidor web.

Propiedades

AllowEditing	Obtiene un valor que indica si la plantilla debe habilitar la edición de su contenido.
Content	Obtiene o establece el formato HTML que representa el contenido de la plantilla.
Designer	Obtiene el componente del diseñador asociado. (Heredado de DesignerObject)
Name	Obtiene el nombre del objeto. (Heredado de DesignerObject)
Properties	Obtiene las propiedades del objeto. (Heredado de DesignerObject)
ServerControlsOnly	Obtiene un valor que indica si la plantilla debe limitar el contenido a controles de servidor Web, como se establece en el constructor TemplateDefinition. Esta propiedad es de sólo lectura.
Style	Obtiene el estilo que debe aplicarse a la plantilla, como se establece en el constructor TemplateDefinition. Esta propiedad es de sólo lectura.
SupportsDataBinding	Obtiene o establece un valor que indica si la plantilla admite el enlace de datos.
TemplatedObject	Obtiene el componente en el que reside la plantilla. Esta propiedad es de sólo lectura.
TemplatePropertyName	Obtiene el nombre de propiedad de la plantilla que el host de diseño debe mostrar en la cuadrícula de propiedades.

Métodos

Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetService(Type)	Obtiene un servicio del host de diseño identificado por el tipo proporcionado. (Heredado de DesignerObject)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Implementaciones de interfaz explícitas

IServiceProvider.GetService(Type)

Para obtener una descripción de este miembro, vea GetService(Type). (Heredado de DesignerObject)

Métodos de extensión

GetKeyedService<T>(IServiceProvider, Object)	Obtiene un servicio de tipo T de .IServiceProvider
GetKeyedServices(IServiceProvider, Type, Object)	Obtiene una enumeración de servicios de tipo serviceType de .IServiceProvider
GetKeyedServices<T>(IServiceProvider, Object)	Obtiene una enumeración de servicios de tipo T de .IServiceProvider
GetRequiredKeyedService(IServiceProvider, Type, Object)	Obtiene un servicio de tipo serviceType de .IServiceProvider
GetRequiredKeyedService<T>(IServiceProvider, Object)	Obtiene un servicio de tipo T de .IServiceProvider
CreateAsyncScope(IServiceProvider)	Crea una instancia de AsyncServiceScope que se puede usar para resolver los servicios con ámbito.
CreateScope(IServiceProvider)	Crea una instancia de IServiceScope que se puede usar para resolver los servicios con ámbito.
GetRequiredService(IServiceProvider, Type)	Obtiene el servicio de tipo serviceType de IServiceProvider.
GetRequiredService<T>(IServiceProvider)	Obtiene el servicio de tipo T de IServiceProvider.
GetService<T>(IServiceProvider)	Obtiene el servicio de tipo T de IServiceProvider.
GetServices(IServiceProvider, Type)	Obtiene una enumeración de los servicios de tipo serviceType de IServiceProvider.
GetServices<T>(IServiceProvider)	Obtiene una enumeración de los servicios de tipo T de IServiceProvider.
GetFakeLogCollector(IServiceProvider)	Obtiene el objeto que recopila los registros enviados al registrador falso.
GetFakeRedactionCollector(IServiceProvider)	Obtiene la instancia falsa del recopilador de redactores del contenedor de inserción de dependencias.

Consulte también

• ControlDesigner
• TemplateGroups
• TemplatedControlDesigner
• Ampliar compatibilidad en tiempo de diseño
• Cómo: Extender la apariencia y el comportamiento de los controles en modo de diseño