ASP.NET 提供了一种称为模板的通用功能,允许将控制数据与其表示分开。模板化控件本身不提供用户界面 (UI)。该控件的 UI 由页面开发人员通过内联模板提供,该模板允许页面开发人员自定义该控件的 UI。如果您不熟悉 ASP.NET 中的模板,请参见 ASP.NET 快速入门 —> ASP.NET Web 窗体 —> 数据访问和自定义 —>“模板化控件介绍”中的示例。
开发模板化控件
- 实现 System.Web.UI.INamingContainer 接口。这是没有任何方法的标记接口。它可以在您的控件下创建新的命名范围,这样子控件就在名称树中有了唯一的标识符。
[C#] public class TemplatedFirstControl : Control,INamingContainer {...}
- 将 ParseChildrenAttribute 应用到您的控件,并传递 true 作为参数。在 ASP.NET 页上声明性地使用控件时,这样可指示页分析器如何分析模板属性标记。步骤 3 说明如何定义一个模板属性。
注意 如果您的控件是从 WebControl 派生的,则不需要应用 ParseChildrenAttribute,因为 WebControl 已经用该属性作了标记。
[C#] [ ParseChildren(ChildrenAsProperties = true)] public class TemplatedFirstControl : Control, INamingContainer {...}
有关 ParseChildrenAttribute 的更多信息,请参见使用 ParseChildrenAttribute。
- 定义 System.Web.UI.ITemplate 类型的一个或多个属性。ITemplate 有一个方法 InstantiateIn,该方法可使用页上内联提供的模板创建控件。您不必实现 InstantiateIn 方法;ASP.NET 页框架可提供这种实现。ITemplate 属性必须有 System.Web.UI.TemplateContainerAttribute 类型的元数据属性,它指出哪种 INamingContainer 控件将拥有实例化模板。这在步骤 4 中作了说明。以下代码片段定义了一个模板属性。
[C#] [TemplateContainer(typeof(FirstTemplateContainer))] public ITemplate FirstTemplate {...}
- TemplateContainerAttribute 的参数是您想在其中实例化模板的容器控件类型。容器控件独立于正在创作的模板化控件。具有逻辑容器的原因是:模板化控件通常有一个模板,该模板需要使用不同数据重复实例化。拥有与根模板化控件不同的容器控件,使拥有多个此类示例成为可能。逻辑容器是该模板内子控件的即时 INamingContainer。在开发模板化数据绑定控件中更详细地介绍了这种关系。
注意 容器控件本身必须实现 INamingContainer,因为它有需要在页上唯一命名的子控件。
[C#] public class FirstTemplateContainer : Control, INamingContainer {...}
- 重写 CreateChildControls 方法以便在模板中创建子控件。这是通过三个步骤来完成的。
- 实例化模板容器。
- 调用模板属性的 InstantiateIn 方法并将该容器作为参数传递给它。InstantiateIn 方法(在 ITemplate 接口中声明)实例化该模板的元素,作为该模板容器的子控件。您不必实现 InstantiateIn 方法;ASP.NET 页框架可提供这种实现。
- 将模板容器的示例添加到您的模板化控件的 Controls 集合。
以下代码片段说明了 CreateChildControls 的实现。
[C#] 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 方法以确保调用已注册的事件处理程序。
[C#] protected override void OnDataBinding(EventArgs e) { EnsureChildControls(); base.OnDataBinding(e); }
- 在步骤 5 中,在 CreateChildControls 方法内重复该逻辑,以便为控件的每个模板属性实例化一个模板。
有关模板化控件、模板的相关容器控件和使用该控件的页的示例,请参见模板化控件示例。