方法 : template 宣言された ASP.NET ユーザー コントロールを作成する

  • [アーティクル]

更新 : 2007 年 11 月

テンプレートを実装するユーザー コントロールを作成できます。この ASP.NET の機能によって、コントロールのデータと表示形式を分離できます。テンプレート宣言されたコントロールは、ユーザー インターフェイスを提供しません。代わりに、このコントロールは、名前付けコンテナを実装し、ホスト ページにアクセスできるプロパティとメソッドを提供するクラスを含むように記述されます。

ユーザー コントロールのユーザー インターフェイスは、デザイン時にページ開発者が提供します。開発者はユーザー コントロールによって定義される型のテンプレートを作成し、コントロールを追加してテンプレートにマークアップできます。

テンプレート ユーザー コントロールを作成するには

  1. テンプレートを作成する ASP.NET PlaceHolder コントロールを .ascx ファイルに追加します。

  2. ユーザー コントロールのコードで、ITemplate 型のプロパティを実装します。

  3. テンプレートのインスタンスを作成するコンテナとして INamingContainer インターフェイスを実装するサーバー コントロールのクラスを定義します。このコンテナは名前付けコンテナと呼ばれます。

    36574bf6.alert_note(ja-jp,VS.90).gifメモ :

    このコントロールは必須ではありませんが、基本的にユーザー コントロールの入れ子になったクラスになります。

  4. ITemplate を実装するプロパティに TemplateContainerAttribute を適用し、テンプレートの名前付けコンテナの型を属性のコンストラクタの引数として渡します。

  5. コントロールの Init メソッドで、次の手順を 1 回以上繰り返します。

    • 名前付けコンテナ クラスのインスタンスを作成します。

    • 名前付けコンテナ内のテンプレートのインスタンスを作成します。

    • 名前付けコンテナのインスタンスを PlaceHolder サーバー コントロールの Controls プロパティに追加します。

      36574bf6.alert_note(ja-jp,VS.90).gifメモ :

      ユーザー コントロールを使用するページにおけるテンプレート宣言されたユーザー コントロールの構文は、カスタムにテンプレート宣言されたコントロールと同じです。

使用例

テンプレート宣言されたユーザー コントロールおよびそれを含むページの例を次に示します。このユーザー コントロールは、ホスト ページで <MessageTemplate> として宣言できるテンプレートを作成します。このテンプレート コントロールには、ホスト ページがテンプレート内でアクセスできる Index と Message という 2 つのプロパティもあります。

最初のサンプルに、テンプレート宣言されたユーザー コントロールを示します。2 番目のサンプルは、ユーザー コントロールを含むページを表示します。

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

<script runat="server" >
    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 runat="server" ID="PlaceHolder1" />

<%@ Control language="C#" ClassName="TemplatedUC" %>
<%@ Import Namespace="System.ComponentModel"  %>
<script runat="server">
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 runat="server" 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 runat="server">
    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" runat="server">
<uc:TemplateTest runat="server">
  <MessageTemplate>
    Index: <asp:Label runat="server" ID="Label1" 
                Text='<%# Container.Index %>' />
    <br />
    Message: <asp:Label runat="server" 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 runat="server">
    protected void Page_Load()
    {
        DataBind();
    }
    
</script>
<head>
<title>Templated User Control Test</title>
</head>
<body>
<h1>Testing Templated User Control</h1>
<form id="Form1" runat="server">
<uc:TemplateTest runat="server">
  <MessageTemplate>
    Index: <asp:Label runat="server" ID="Label1" 
        Text='<%# Container.Index %>' />
    <br />
    Message: <asp:Label runat="server" ID="Label2" 
        Text='<%# Container.Message %>' />
    <hr />
  </MessageTemplate>
</uc:TemplateTest>
</form>
</body>
</html>

参照

概念

ASP.NET ユーザー コントロールの概要