Partilhar via


Como: Criar Templated ASP.NET usuário Controls

Você pode criar controles de usuário que implementam modelos, um recurso ASP.NET que permite a separação de dados de Controle de sua apresentação.Um controle modelo não fornece uma interface de usuário.Em vez disso, ele é escrito para implementar um contêiner de nomeação e para incluir uma classe cujas propriedades e métodos estão acessíveis para a página host.

A interface do usuário para o controle de usuário é fornecida por um desenvolvedor de Página no tempo de projeto.O desenvolvedor cria modelos do tipo definido pelo controle de usuário, e seguida, pode adicionar controles e marcação para os modelos.

Para criar um controle modelo de usuário

  1. No arquivo .ascx, adicione um controle ASP.NET PlaceHolder onde você deseja que o modelo a seja exibido.

  2. No código do controle de usuário, implemente uma propriedade do tipo ITemplate.

  3. Defina uma classe de controle de servidor que implementa a interface INamingContainer como um contêiner no qual cria uma instância do modelo.Isso é chamado de contêiner de Nomeação do modelo.

    Observação:

    Esse controle essencialmente torna-se uma classe aninhada do controle de usuário, embora isso não seja necessário.

  4. Aplique o TemplateContainerAttribute para a propriedade que implementa ITemplate e passe o tipo do contêiner de nomeação do modelo como o argumento para o atributo do construtor.

  5. No controle do método Init, repita uma ou mais vezes as etapas a seguir:

    • Crie uma instância da classe do contêiner de nomeação.

    • Crie uma instância do modelo no contêiner de nomeação.

    • Adicione a instância do contêiner de nomeação à propriedade Controls do PlaceHolder controle de servidor.

      Observação:

      Do ponto de vista da página usando o controle de usuário, a sintaxe para o controle modelo de usuário é idêntica ao que seria com um controle modelo personalizado.

Exemplo

O exemplo a seguir mostra um controle modelo de usuário e uma página que o contém.O controle de usuário cria um modelo que pode ser declarado em uma página host como <MessageTemplate>.O controle modelo também expõe duas propriedades, Index e Message, que a página host pode acessar dentro do modelo.

O primeiro exemplo mostra o controle modelo de usuário.O segundo exemplo mostra uma página que contém o controle de usuário.

<%@ Control language="VB" ClassName="TemplatedUC" %>
<%@ Import Namespace="System.ComponentModel"  %>

<script  >
    Private m_messageTemplate As ITemplate = Nothing
    <TemplateContainer(GetType(MessageContainer))> _
    <PersistenceMode(PersistenceMode.InnerProperty)> Public Property _
            MessageTemplate() As ITemplate
        Get
            Return m_messageTemplate
        End Get
        Set(ByVal value As ITemplate)
            m_messageTemplate = Value
        End Set
    End Property
    
    Sub Page_Init()
        If Not (MessageTemplate Is Nothing) Then
            Dim i As Integer
            Dim fruits() As String = _
                {"apple", "orange", "banana", "pineapple"}
            For i = 0 To 3
                Dim container As New MessageContainer(i, fruits(i))
                MessageTemplate.InstantiateIn(container)
                PlaceHolder1.Controls.Add(container)
            Next i
        End If
    End Sub

    Public Class MessageContainer
        Inherits Control
        Implements INamingContainer

        Private m_index As Integer
        Private m_message As String
        Friend Sub New(ByVal i As Integer, ByVal msg As String)
            Me.Index = i
            Me.Message = msg
        End Sub
    
        Public Property Index() As Integer
            Get
                Return m_index
            End Get
            Set(ByVal value As Integer)
                m_index = value
            End Set
        End Property

        Public Property Message() As String
            Get
                Return m_message
            End Get
            Set(ByVal value As String)
                m_message = value
            End Set
        End Property
    End Class
</script>
<asp:Placeholder  ID="PlaceHolder1" />
<%@ Control language="C#" ClassName="TemplatedUC" %>
<%@ Import Namespace="System.ComponentModel"  %>
<script >
private ITemplate messageTemplate = null;

[ TemplateContainer(typeof(MessageContainer)) ]
[ PersistenceMode(PersistenceMode.InnerProperty) ]
public ITemplate MessageTemplate {
    get 
    { 
        return messageTemplate; 
    }
    set 
    { 
        messageTemplate = value; 
    }
}

void Page_Init() {
    if (messageTemplate != null) {
        String[] fruits = {"apple", "orange", "banana", "pineapple" };
        for (int i=0; i<4; i++) 
        {
            MessageContainer container = new MessageContainer(i, fruits[i]);
            messageTemplate.InstantiateIn(container);
            PlaceHolder1.Controls.Add(container);
        }
    }
}

public class MessageContainer: Control, INamingContainer {
    private int m_index;
    private String m_message;
    internal MessageContainer(int index, String message)
    { 
        m_index = index;
        m_message = message;
    }
    public int Index {
        get 
        { 
            return m_index; 
        } 
    }
    public String Message 
    { 
        get 
        { 
            return m_message; 
        } 
    }
}
</script>
<asp:Placeholder  ID="PlaceHolder1" />
<%@ Page Language="VB" %>
<%@ Register TagPrefix="uc" tagname="TemplateTest" 
    Src="TemplatedUC.ascx" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<script >
    Sub Page_Load()
        DataBind()
    End Sub
</script>
<head>
<title>Templated User Control Test</title>
</head>
<body>
<h1>Testing Templated User Control</h1>
<form id="Form1" >
<uc:TemplateTest >
  <MessageTemplate>
    Index: <asp:Label  ID="Label1" 
                Text='<%# Container.Index %>' />
    <br />
    Message: <asp:Label  ID="Label2" 
        Text='<%# Container.Message %>' />
    <hr />
  </MessageTemplate>
</uc:TemplateTest>
</form>
</body>
</html>
<%@ Page Language="C#" %>
<%@ Register TagPrefix="uc" tagname="TemplateTest" 
    Src="TemplatedUC.ascx" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<script >
    protected void Page_Load()
    {
        DataBind();
    }
    
</script>
<head>
<title>Templated User Control Test</title>
</head>
<body>
<h1>Testing Templated User Control</h1>
<form id="Form1" >
<uc:TemplateTest >
  <MessageTemplate>
    Index: <asp:Label  ID="Label1" 
        Text='<%# Container.Index %>' />
    <br />
    Message: <asp:Label  ID="Label2" 
        Text='<%# Container.Message %>' />
    <hr />
  </MessageTemplate>
</uc:TemplateTest>
</form>
</body>
</html>

Consulte também

Conceitos

Visão geral sobre controles de usuário ASP.NET