テンプレートユーザーコントロールの作成

2008-03-28

テンプレート (コントロールのデータをコントロール自体の表示とは分離できる ASP.NET 機能) を実装するユーザーコントロールを作成できます。テンプレートコントロールは、ユーザーインターフェイス (UI) を提供しません。コントロールの UI は、ページ開発者がインラインテンプレートを使用して提供します。インラインテンプレートを使用すると、コントロールの UI をカスタマイズできます。テンプレートユーザーコントロールを作成することによって、カスタムコントロールを .dll ファイルにコンパイルせずにユーザーコントロールをアプリケーションのページに簡単に追加できるようになります。

カスタムテンプレートコントロールの作成の詳細については、「テンプレートコントロールの開発」を参照してください。

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

.ascx ファイルで、テンプレートを表示する ASP.NET Placeholder Web サーバーコントロールを宣言によって作成します。
ユーザーコントロールのコード宣言ブロックまたは分離コードクラスで、ITemplate 型のプロパティを実装します。
同じコードブロックで、INamingContainer を実装するサーバーコントロールを、テンプレートのインスタンスを作成するためのコンテナとして定義します。このコンテナは名前付けコンテナと呼ばれます。

メモ基本的に、このコントロールは、ユーザーコントロールの入れ子にされたクラスになりますが、これは必須ではありません。
TemplateContainerAttribute を ITemplate プロパティに適用し、そのテンプレートの名前付けコンテナの型を引数としてコンストラクタまたは属性に渡します。
Page_Init メソッドで、次の手順を 1 回以上繰り返します。
- 名前付けコンテナクラスのインスタンスを作成します。
- 名前付けコンテナ内のテンプレートのインスタンスを作成します。
- 名前付けコンテナインスタンスを PlaceHolder サーバーコントロールの Controls プロパティに追加します。
  
  メモユーザーコントロールを使用するページの観点からすると、テンプレートユーザーコントロールの構文はカスタムテンプレートコントロールの構文と同じになります。

テンプレートユーザーコントロールとそのテンプレートユーザーコントロールを含むページの例を次に示します。

メモこの例では、1 つのテンプレートプロパティだけを公開していますが、アプリケーションを正常に動作させるために必要なだけテンプレートプロパティを公開できます。

テンプレートユーザーコントロール

<%@ Control language="VB" debug="True" %>
<script runat="server" >
Private messageTemplate As ITemplate = Nothing
<TemplateContainer(GetType(MessageContainer))>Public Property MessageTemplate() As ITemplate
    Get
        Return messageTemplate
    End Get
    Set
        messageTemplate = value
    End Set
End Property
    
Sub Page_Init()
    If Not (messageTemplate Is Nothing) Then
        Dim i As Integer
        For i = 0 To 4
            Dim container As New MessageContainer(i)
            messageTemplate.InstantiateIn(container)
            msgholder.Controls.Add(container)
        Next i
    End If
End Sub 'Page_Init


Public Class MessageContainer
    Inherits Control
    Implements INamingContainer 

    Private index As Integer
    
    Friend Sub New(index As Integer)
        Me.index = index
    End Sub 'New
    
    Public ReadOnly Property Index() As Integer
        Get
            Return index
        End Get
    End Property 
End Class 'MessageContainer
</script>

<hr>
<asp:placeholder runat=server id=msgholder/>
<hr>
[C#]
<%@ Control language=c# debug=true %>
<script runat=server>
private ITemplate messageTemplate = null;      

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

void Page_Init() {
    if (messageTemplate != null) {
        for (int i=0; i<5; i++) {
            MessageContainer container = new MessageContainer(i);
            messageTemplate.InstantiateIn(container);
            msgholder.Controls.Add(container);
        }
    }
}

public class MessageContainer: Control, INamingContainer {
    private int index;
    internal MessageContainer(int index) { this.index = index; }
    public int Index { get { return index; } }
}

</script>

<hr>
<asp:placeholder runat=server id=msgholder/>
<hr>

テンプレートユーザーコントロールを含む ASP.NET ページ

<%@ language=vb debug=true %>
<%@ Register TagPrefix="acme" tagname="test" src=TemplatedUserControl.ascx %>
<html>
<script runat=server>
    Sub Page_Load()
        DataBind()
    End Sub 'Page_Load
</script>
<body>
' The Container in the data-binding syntax will automatically be of type
' MessageContainer, since the TemplateContainer attribute was applied 
' to the ITemplate class in the .ascx file.
<form runat=server>
<acme:test runat=server>
    <MessageTemplate>
        Hello #<%# Container.Index %>.<br>
    </MessageTemplate>
</acme:test>
</form>
</body>
</html>
[C#]
<%@ language=c# debug=true %>
<%@ Register TagPrefix="acme" tagname="test" src=TemplatedUserControl.ascx %>
<html>
<script runat=server>
    void Page_Load() {
        DataBind();
    }
</script>
<body>
// The Container in the data-binding syntax will automatically be of type
// MessageContainer, since the TemplateContainer attribute was applied 
// to the ITemplate class in the .ascx file.
<form runat=server>
<acme:test runat=server>
    <MessageTemplate>
        Hello #<%# Container.Index %>.<br>
    </MessageTemplate>
</acme:test>
</form>
</body>
</html>

参照

Web フォームユーザーコントロール | Web フォームのコードモデル | Web フォームページへのユーザーコントロールの取り込み | @ Control | UserControl

次の方法で共有

テンプレート ユーザー コントロールの作成

参照

その他のリソース

テンプレートユーザーコントロールの作成