テンプレートコントロールの開発

[アーティクル]
03/28/2008

ASP.NET には、テンプレートと呼ばれる用途の広い機能があり、これによってコントロールのデータをコントロール自体の表示とは分離できます。テンプレートコントロール自体はユーザーインターフェイス (UI) を提供しません。コントロールの UI は、ページ開発者がインラインテンプレートを使用して提供します。インラインテンプレートを使用すると、コントロールの UI をカスタマイズできます。ASP.NET のテンプレートの詳細については、「ASP.NET クイックスタート」の「.NET サンプル - ASP.NET コントロールの作成」で「Template1 サンプル」の例を参照してください。

テンプレートコントロールを開発するには

System.Web.UI.INamingContainer インターフェイスを実装します。このインターフェイスは、メソッドのないマーカーインターフェイスです。これにより、コントロールの下に名前付けスコープが作成されるため、名前付けツリーの子コントロールにそれぞれ一意の識別子が付けらるようになります。
```
public class TemplatedFirstControl : Control,INamingContainer 
{...}
```
ParseChildrenAttribute をコントロールに適用し、引数として true を渡します。これにより、ASP.NET ページでコントロールが宣言によって使用されるときのテンプレートプロパティタグの解析方法をページパーサーに示します。テンプレートプロパティの定義方法については、手順 3 で説明します。

メモ WebControl から派生したコントロールの場合、WebControl が既に ParseChildrenAttribute でマークされているため、この属性を適用する必要はありません。
```
[ ParseChildren(ChildrenAsProperties = true)]
public class TemplatedFirstControl : Control, INamingContainer {...}
```
ParseChildrenAttribute の詳細については、「ParseChildrenAttribute の使用方法」を参照してください。
System.Web.UI.ITemplate 型のプロパティを 1 つ以上定義します。ITemplate には、ページにインラインで組み込まれているテンプレートを使用してコントロールを作成する InstantiateIn メソッドがあります。InstantiateIn メソッドは、ASP.NET ページフレームワークによって実装されるため、実装する必要はありません。ITemplate プロパティには、インスタンス化されたテンプレートを保持する INamingContainer コントロールを示す、System.Web.UI.TemplateContainerAttribute 型のメタデータ属性が必要です。この属性については、手順 4 で説明します。テンプレートプロパティを定義するコードを次に示します。
```
[TemplateContainer(typeof(FirstTemplateContainer))]                 
 public ITemplate FirstTemplate {...}
```
TemplateContainerAttribute の引数は、その内部でテンプレートをインスタンス化するコンテナコントロールの型です。このコンテナコントロールは、作成するテンプレートコントロールには依存しません。論理コンテナを使用する理由は、テンプレートコントロールが、さまざまなデータを使用して繰り返しインスタンス化する必要のあるテンプレートを持つことが多いためです。ルートテンプレートコントロールと異なるコンテナコントロールを使用すると、このような複数のインスタンスを作成できます。論理コンテナは、テンプレート内の子コントロールに対する直接の INamingContainer です。この関係の詳細については、「template 宣言のあるデータ連結コントロールの開発」を参照してください。

メモコンテナコントロールの子コントロールにページ上で一意の名前を付ける必要があるため、このコンテナコントロール自体が INamingContainer を実装する必要があります。
```
public class FirstTemplateContainer : Control, INamingContainer {...}
```
テンプレートに子コントロールを作成するために、CreateChildControls メソッドをオーバーライドします。オーバーライドするには、次の手順に従います。
1. テンプレートコンテナをインスタンス化します。
2. テンプレートプロパティの InstantiateIn メソッドを呼び出して、テンプレートコンテナを引数として渡します。ITemplate インターフェイスで宣言されている InstantiateIn メソッドが、テンプレートの要素をテンプレートコンテナの子コントロールとしてインスタンス化します。InstantiateIn メソッドは、ASP.NET ページフレームワークによって実装されるため、実装する必要はありません。
3. テンプレートコントロールの Controls コレクションに、テンプレートコンテナのインスタンスを追加します。
CreateChildControls の実装を次のコード片に示します。
```
private Control myTemplateContainer;

protected override void CreateChildControls ()          
{
   if (FirstTemplate != null)
   {
      myTemplateContainer = new FirstTemplateContainer(this);
         FirstTemplate.InstantiateIn(myTemplateContainer);
      Controls.Add(myTemplateContainer);
    }
    else
    {
        Controls.Add(new LiteralControl(Text + " " + DateTime));
    }
 }
```
Control から継承した OnDataBinding メソッドをオーバーライドして、EnsureChildControls メソッドを呼び出します。これにより、ページフレームワークがテンプレート内のデータ連結式を評価する前に、必ずテンプレートの子コントロールが作成されます。登録されているイベントハンドラを確実に呼び出せるように、基本クラスの OnDataBinding メソッドを呼び出す必要もあります。
```
        protected override void OnDataBinding(EventArgs e) {
            EnsureChildControls();
            base.OnDataBinding(e);
        }
```
手順 5 で、CreateChildControls メソッド内のロジックを繰り返し実行し、コントロールの各テンプレートプロパティに対してテンプレートをインスタンス化します。

テンプレートコントロール、テンプレートの関連コンテナコントロール、およびこのコントロールを使用するページの例については、「テンプレートコントロールのサンプル」を参照してください。

参照

テンプレートコントロールのサンプル

次の方法で共有

テンプレートコントロールの開発

参照

その他のリソース

次の方法で共有

テンプレート コントロールの開発

参照

その他のリソース

テンプレートコントロールの開発