利用 ASP.NET 2.0 创建自定义 Web 控件
发布日期： 09/03/2004 | 更新日期： 09/03/2004
Jayesh Patel、Bryan Acker、Robert McGovern
Infusion Development
适用于：
Microsoft ASP.NET 2.0
Microsoft Visual Studio 2005
摘要：ASP.NET 2.0 中新的自适应呈现模型为控件编写人员提供了很多新的选项。本文展示了这些选项如何使创建 ASP.NET 的自定义控件变得比以前更加容易。
本页内容
简介
从使用基本的文本编辑器到创作标记页面，Web 开发已经经历了一个漫长的过程。目前，集成开发环境 (IDE) 为开发过程中的几乎每个方面都提供了图形化表示形式。此外，还实现各种说明性编程技术以提高效率并降低出现错误的几率。Visual Studio 2005 和 ASP.NET 2.0 中的控件体系结构遵循了这些编程趋势，并且提供了可靠的、可扩展的环境，该环境设计为使开发人员可以创建能够以说明方式配置的控件。
此外，ASP.NET 中新的自适应呈现模型减少了编写可专门识别其目标浏览器的控件的需要。换句话说，控件开发人员可以专注于设计控件，而让 ASP.NET 框架负责转换控件并针对不同类型的浏览器和设备呈现它。
尽管 ASP.NET 2.0 在控件设计过程中提供了增量改进功能，但实际控件呈现模型已经完全进行了更改。作为自定义控件开发人员，您将会看到利用 ASP.NET 的几个新选项。最重要的是，您将会发现只需编写较少的代码便可完成相同的任务。
在 ASP.NET 2.0 中，创建自定义服务器控件有很多方法，每种方法都有其优点和局限性。本文将讨论与自定义控件的创建和配置相关的详细信息。代码示例和体系结构概念要求您对 C# 编程语言具有中等水平的理解。
自适应呈现模型
在 ASP.NET 1.x 中，自定义控件开发人员必须设计每个服务器控件，以便它可以识别不同的浏览器类型并发出正确的输出。ASP.NET 1.x 控件框架提供了几项功能以使该任务变得更简单，但开发人员仍然必须根据浏览器的类型编写切换程序、开发适当的 HTML，然后针对不同类型的浏览器测试控件。此外，如果开发人员希望控件在移动设备上显示，他必须创建一个与普通 Web 浏览器上使用的控件不同的全新控件。
ASP.NET 2.0 通过新的自适应呈现模型简化了浏览器检测和呈现过程。在 ASP.NET 2.0 中引入的自适应呈现模型旨在用于支持那些众多能够使用标记格式（包括 HTML、WML、XHTML 或 CHMTL）的不同设备。
自适应呈现模型体系结构
每个控件都可以链接到一个适配器，它会针对特定的目标设备修改控件的行为和标记。例如，HTML 适配器将 ASP.NET 控件生成为标准的 HTML 和 DHTML，以便普通 Web 浏览器使用。另一方面，WML 适配器将相同的控件转换成无线标记语言，以便蜂窝电话或其他移动设备使用。
图 1. 控件-适配器寿命周期
上图说明了控件方法与适配器方法之间一对一的映射。如果有适配器（如果控件的 Adapter 属性不为空），执行就会在控件和适配器方法之间传输，如上图所示。在生成阶段，控件对象或适配器对象都可以生成输出（通常情况下两者不同时生成输出）。通常情况下，如果有适配器，那么适配器的实现将覆盖控件的实现。在 ASP.NET 2.0 中，自适应呈现模型适用于所有 ASP.NET 控件（不仅仅是移动控件），并且允许 ASP.NET 2.0 支持统一的控件体系结构。
实际意义
自适应呈现模型的实际意义有两个主要方面。第一，作为开发人员，您可以一次设计控件并期望它可以在具有适配器的任何类型的设备或浏览器上使用。第二，您可以对常用适配器利用广泛的 Microsoft 测试，减少您自己浏览器的特定测试。
自适应呈现模型还为 ASP.NET 2.0 提供了将其他服务添加到控件生成过程中的机会。由于具有适配器模型，您可以：
| • |
根据目标的类型，使用筛选器 来更改控件的外观。 |
| • |
根据目标的类型，使用模板来更改整个页面布局。 |
| • |
根据浏览器控制在浏览器上的呈现，而不必依赖于 ASP.NET 1.x 的 uplevel/downlevel 确定。 |
在本文中，我们将重点放在创建自定义控件的应用方面。但是，请牢记自适应呈现模型是新的基础框架。
创建自定义服务器控件
Visual Studio 2005 提供了很多用于开发自定义服务器控件的有用工具。为了说明某些功能，我们将创建一个 MailLink 控件，它公开了两个属性：Email 和 Text。该控件将生成必需的 HTML 来将所提供的 Text 包装到 mailto: 链接标记中。
创建项目
在 Visual Studio 2005 中，我们通过在新建项目向导中选择适当的图标来创建一个新的“Web Control Library”项目：
图 2. Visual Studio 2005 中的新建项目向导
该项目是利用默认的自定义控件类实现创建的。对于我们的示例，我们将该默认文件重命名为 MailLink.cs。
注：在解决方案资源管理器中重命名该文件时，Visual Studio 2005 将会自动更新类名。
MailLink 的源代码在由项目向导生成的默认模板上构建。MailLink 类从 WebControl 基类自动派生。
public class MailLink : WebControl {
WebControl 类提供默认实现方法，可以很简单地覆盖这些方法来为我们的控件提供详细说明。
添加属性
在 MailLink 示例中，我们需要添加 Email 和 Text 属性。为了正确配置这些属性，我们不仅必须编写代码，还要分配几个特性。
[Bindable(true),
Category("Appearance"),
DefaultValue(""),
Description("The e-mail address.")]
public virtual string Email {
get {
string s = (string)ViewState["Email"];
return (s == null) ? String.Empty : s;
}
set {
ViewState["Email"] = value;
}
}
特性（以粗体表示）定义了新控件将如何与设计器 (Visual Studio) 进行交互。Email 属性的特性告诉 Visual Studio 如何在设计过程中处理属性：
| • |
Bindable — Email 属性可绑定 到数据源。您可以将 Email 字段链接到数据库、XML 文件或任何其他 DataSet。该特性强制 Visual Studio 在控件的可绑定属性列表中显示 Email 属性。 |
| • |
Appearance —Email 属性将显示在 Appearance 类别下的属性视图中。您可以选择想要的任何类别，包括默认类别：Appearance、Accessibility、Behavior、Data、Layout 或 Misc。只要用户选择了属性的类别组织方法，Email 属性将会显示在 Appearance 下。 |
| • |
DefaultValue — Email 属性具有一个空的默认值。尽管空值对于 Email 字段来说有意义，但对于您添加到控件中的其他属性可能并不合适。当用户将您的控件放到他们的 Web 页上时，选择适当的默认值可为用户免去不计其数的单击操作。 |
| • |
Description — 属性说明显示在控件列表下，并且也可能作为工具提示出现。Email 属性将具有 The e-mail address 说明。 |
| • |
Localizable — 它会用发送信号的方式通知 ASP.NET 2.0 Framework 该控件包括可以针对不同语言或位置进行配置的文本属性。 |
您可以使用 System.ComponentModel 命名空间中的各种特性来进一步改进任何特殊属性的外观和行为。我们将在本文的使用设计器部分中更详细地介绍修改属性或控件的行为的方法。
接下来，我们需要添加 Text 属性。Text 属性与 Email 属性稍有不同，因为我们希望将 Text 显示为由 MailLink 控件发出的 HTML 的一部分。为此，我们需要从 System.Web.UI 命名空间中添加一个新的特性。
[Bindable(true),
Category("Appearance"),
DefaultValue(""),
Description("The text to display on the link."),
Localizable(true),
PersistenceMode(PersistenceMode.InnerDefaultProperty)]
public virtual string Text {
get {
string s = (string)ViewState["Text"];
return (s == null) ? String.Empty : s;
}
Set {
ViewState["Text"] = value;
}
}
Text 属性的 PersistenceMode(PersistenceMode.InnerDefaultProperty) 特性（粗体代码）指定设计器应该将该属性作为控件标记内的内部内容序列化。该特性还声明 Text 是控件的默认属性。当用户在 Visual Studio 中使用这个控件时，Text 属性将会作为该控件的内部文本自动显示在图形设计器上，并且如果用户单击该控件并尝试更改显示的文本，Text 属性将会自动更改。
另一方面，应用到属性的特性会影响设计期间用户与控件的交互方式。在运行过程中，这些特性被 ASP.NET 运行时忽略。
有关 ViewState 的注释
请注意，用于两个属性的 Get 和 Set 方法都利用 ViewState 对象。ViewState 对象是一个内置到 WebControl 类中的帮助器对象。从开发角度讲，ViewState 可被视为一个集合类，用于存储在回发过程中我们想要保留的任意属性。实际上，ViewState 封装了确定如何执行持久性（使用 Cookie、会话等等）所需的所有代码和逻辑。
生成控件
在定义了控件属性之后，接下来的步骤就是要设计将由控件发出的实际响应。在 MailLink 示例中，我们希望设计控件来生成基本的 HTML 标记。
TagKey
WebControl 的默认实现会生成一个 标记。我们的 MailLink 控件通过为 TagKey 属性提供它自己的实现来覆盖该默认实现。TagKey 属性定义将要封装控件内容的最外面的标记。
幸运的是，我们可以使用 HtmlTextWriterTag 枚举来指示链接 标记，而不必实际编写 HTML 文本。该枚举方法用于最常用的 HTML 标记。
protected override HtmlTextWriterTag TagKey {
get {
return HtmlTextWriterTag.A;
}
}
如果您需要生成一个不属于 HtmlTextWriterTag 枚举的一部分的标记，您必须覆盖 WebControl.TagName 属性，而非 TagKey 属性。TagName 属性会返回由控件生成的实际 HTML 标记字符串。TagName 的默认 WebControl 实现只调用 TagKey，并以完美的提取方式提取正确的 HTML。
AttributesToRender
在定义了基本标记之后，接下来的步骤就是分配我们要添加到该标记中的各种特性。我们的 MailLink 控件将覆盖 AddAttibutesToRender 方法以便为“mailto”标记添加适当的标记。
protected override void AddAttributesToRender(
HtmlTextWriter writer){
base.AddAttributesToRender(writer);
writer.AddAttribute(HtmlTextWriterAttribute.Href,
"mailto:" + Email);
}
对基类的 addAtributeToRender() 调用会被调用，以确保可以正确生成其他样式和特性。如果我们忽略该基本调用，我们可能会失去内置到所有 Web 控件中的母版页设计、筛选器或其他功能。
RenderContents
最后，由于所需的 WebControl 类的方法和属性都已被覆盖，因此可以使用 RenderContents 方法来编写文本。出于安全原因，MailLink 使用 HtmlTextWriter.WriteEncodedText 方法编写 HTML 编码输出。HTML 编码安全地将潜在的危险字符转换为更安全的表示形式。
protected override void RenderContents(
HtmlTextWriter writer) {
if (Text == String.Empty) {
Text = Email;
}
writer.WriteEncodedText(Text);
}
请注意，我们只生成 Text 属性。如果 Text 属性为空，我们将利用 Email 属性填充它。请记住，Text 属性旨在用作控件标记的内部文本。这种类型的控件至少需要某一可显示的文本（以便用户进行单击）。如果我们试图生成一个空字符串，我们将失去链接标记的预期功能。
如何生成的？
Render() 方法基本上控制着 WebControl 的整个输出。默认情况下，Render() 方法实际上会依次调用 RenderBeginTag()、RenderContents() 以及 RenderEndTag()。尽管在 ASP.NET 1.x 中调用结构并未变化，但由于该呈现模型，修改这些调用的影响却发生了变化。
您可以覆盖 Render() 方法来发出您想要的任何内容。换句话说，您可能已经跳过了覆盖 TagKey 属性、AttributestoRender 属性和 RenderContents() 方法，并且仅使 Render() 编写“text”。但是，这种做法可能会严重影响自适应呈现。如果重写 Render() 来直接发出最终输出，您会绕过内置到 WebControl 类中的大多数自适应呈现特性。
自适应呈现模型和各种适配器的作用是：截获对各种标记方法的调用并转换特定设备的输出。在 MailLink 的特定示例中，几乎所有的标记语言都支持用于 链接的相同语法。但是，其他标记通常在不同的标记语言中会有截然不同的转换。如果我们为这样的标记使用了 Render()，我们的控件将只能在某些浏览器上使用，而适配器无法更改该行为。通过设计控件以使用自适应元素而不是使用 Render()，您可以让 ASP.NET 框架有机会根据浏览器提供在浏览器上的呈现服务。
使用自定义控件
自定义控件能够以很多方法包括在 Web 应用程序中。标准方法是将自定义控件编译到一个程序集中，然后在使用该控件的所有 Web 应用程序中添加一个对该程序集的引用。
使用 EmailLink
为了使用 EmailLink 控件，您需要：
|
1. |
将 MyControls 项目编译到一个程序集中。
图 3. 编译包含 EmailLink 控件的 MyControls 命名空间
|
|
2. |
在新的 Web 项目中添加一个对已编译程序集的引用。
图 4. 编译应用程序并添加一个引用
|
在正确添加引用之后，自定义控件应该出现在工具箱中的“MyControls Components”下。
图 5. 工具箱中的 EmailLink
MyControls 程序集中的所有组件都使用默认的齿轮图标，因为我们未曾在每个控件上设置特定的图标。设置图标如同在该控件类上调整图标属性那样简单。
页面上的控件
在添加了对包含控件的程序集的引用之后，您可以将 MailLink 控件拖动到设计器表面并像使用任何其他 ASP.NET 服务器控件那样使用它。
图 6. MailLink 自定义控件
图 6 展示了 MailLink 控件的设计器视图。请注意，Properties 窗口公开了预期的 Email 和 Text 元素，它们可以用于配置控件。通过将自定义控件编译到可重复使用的程序集中，MailLink 控件可以被很多 Web 应用程序重复使用。
创建复合服务器控件
诸如 Login 和 GridView 这些可靠的控件是由很多基本控件组成的。在 ASP.NET 1.x 中，您必须通过艰苦的工作将嵌套标记和元素添加到自定义控件中来开发复合控件。在 ASP.NET 2.0 中，您可以通过扩展 System.Web.UI.WebControls.CompositeControl 类来构建复杂的复合控件。CompositeControl 类提供了将多个控件的输出合并到单个统一的控件中所必需的框架。
管理复合控件比管理基本自定义控件稍微困难一些，因为复合控件需要一些自定义布局的信息。复合控件将它们的呈现和事件处理任务委托给构成控件。子组件的所有关联的适配器类也会被自动应用。这样，如果您具有适当的适配器，复合控件将会在任何目标浏览器类型或设备上正确地呈现。
创建复合控件
创建复合控件的初始过程与创建自定义服务器控件的初始过程相似。但是，该过程还涉及了更多的步骤。在以下示例中，我们将创建一个由 Label 和 TextBox 组成的简单的复合 AgeCollector 控件，它旨在收集生日的信息。
复合控件类应该通过从 CompositeControl 继承开始。
public class AgeCollector : CompositeControl
{
}
定义属性
对于我们的简单控件，我们必须为标签 (Prompt) 和文本框 (DateOfBirth) 创建属性。
[Bindable(true), Category("Appearance"),
DefaultValue("Please enter your date of birth:"),
Description("Text to prompt user with.")
Localizable(true)]
public virtual String Prompt {
get
{
string s = (string)ViewState["Prompt"];
return (s == null) ? String.Empty : s;
}
set {
ViewState["Prompt"] = value;
}
}
再一次，我们使用特性为属性提供说明和默认值。我们选择了使提示可以进行本地化，以便该控件无论何时都可以用于要求进行国际化的应用程序中。实际的提示可以绑定到包含语言特定文本的资源文件。
还必须定义 DateOfBirth 属性。但是，我们不是使用 String，而是使用 DateTime 数据类型来正确地存储日期。
[Bindable(true), Category("Appearance"),
DefaultValue(""),
Description("Date of Birth Input area")]
public virtual DateTime DateOfBirth {
get
{
bject o = ViewState["DateOfBirth"];
return (o == null) ? DateTime.Now : (DateTime)o;
}
set {
ViewState["DateOfBirth"] = value;
}
}
CreateChildControls 方法
我们的复合控件由一个标签和一个文本框组成。我们无法使用简单控件的技术来显示这两个标记，除非使用强制方式和 Render() 方法。因为我们希望利用自适应呈现并显示我们的两个控件，所以我们需要覆盖内置到 CompositeControl 类中的 CreateChildControls() 方法。这种方法使我们可以定义控件，并将我们的复合控件的属性传递到要显示的单个控件中。
protected override void CreateChildControls() {
//Create and load the label
Label lab1 = new Label();
lab1.Text = Prompt;
lab1.ForeColor = this.ForeColor;
this.Controls.Add(lab1);
//Add a line break between the label and text box
Literal lit = new Literal();
lit.Text = "";
this.Controls.Add(lit);
//Add the Textbox
TextBox tb = new TextBox();
tb.ID = "tb1";
tb.Text = DateOfBirth.ToString();
this.Controls.Add(tb);
//call the parent method
base.CreateChildControls();
}
请注意，我们必须初始化每个控件、分配所有属性，然后将控件添加到内置到 CompositeControl 类中的 Controls 集合。我们还使用了 Literal 对象将换行符
置于标签和控件之间。Literal 对象是非常简单的控件，您可以使用它在功能元素之间插入原始 HTML。
请注意，我们还对基本方法进行了调用，以便确保我们的复合控件具有内置到 CompositeControl 基类中的任何其他功能。尤其是，基本方法会强制 ASP.NET 将 Controls 集合的所有元素添加到控件树中。如果我们忽略这个调用，或者将其置于我们方法的顶部，那么复合控件将不会正确地生成。
完整的 AgeCollector
当我们的 AgeCollector 控件生成时，ASP.NET 将在每个子控件上实际调用适当的方法，并将结果合并到复合控件的输出中。换句话说，如果我们已正确地设计了简单控件，那么该复合控件就只是一个容器。自适应呈现模型将会自动应用到每个子控件中。但是，实际的 CompositeControl 将不会被修改，因为它不包含需要更改的任何控件。
以下是另一个实例，其中使用的适当方法 (CreateChildControls()) 利用了自适应呈现模型，而不是简单地在 WebControl 上重载 Render() 方法。由于自适应呈现模型和 CompositeControl 的特性，ASP.NET 2.0 节省了我们的开发时间、减少了代码行数并减少了很多的测试烦恼。只要我们知道元素控件可通过特定适配器正确地生成，CompositeControl 将会通过该适配器正确地生成。
如果我们将控件拖动到 ASP.NET 页面上并查看属性，我们将会看到具有 Prompt 和 DateOfBirth 属性的单个控件。
图 7. AgeCollector 使用
请注意，如果我们将复合控件的 ForeColor 更改为红色，我们实际上更改了 Label 的 ForeColor。但是，我们尚未链接某些其他属性。例如，我们无法更改 DateOfBirth 字段的 ForeColor。换句话说，当您构建一个复合控件时，您始终需要考虑应该公开哪些子控件属性。
添加控件行为
到目前为止，我们设计的两个控件都是简单、静态的控件。也就是说，这些控件不会完成利用普通的内置控件或简单用户控件 (.ascx) 无法完成的任何操作。构建自定义服务器控件的主要原因之一就是要提供使用现有控件集无法执行的新功能。
事件模型
在 Web 窗体页面中，与服务器控件关联的事件由客户端引发并由 Web 服务器处理。对于在客户机上由服务器控件引发的事件，ASP.NET 2.0 事件模型收集有关请求的信息，并使用 HTTP Post 将详细信息传递到服务器。服务器上的 Page Framework 对该公告作出解释以确定发生的事件，然后调用适当的处理程序方法。
图 8. 典型的服务器控件事件
ASP.NET 2.0 可处理几乎所有捕获、传输和解释事件的方法。详细信息对于开发人员来说是隐藏的，开发人员只需要关心服务器上的处理程序方法的实现。
大多数服务器事件要求一个到服务器的往返以便进行处理，因此支持有限数量的单击类型事件。出于性能原因，不支持鼠标悬停和其他内部事件。
回发事件
ASP.NET 2.0 中的很多服务器控件都生成回发事件。回发事件将页面传递到服务器以便进行处理。这是一个非常昂贵的操作，因为它要求页面通过网络进行传递。
回发模型自从 ASP.NET 1.x 就没有进行过显著更改。为了创建一个可处理回发的控件，您的控件必须实现 IPostBackDataHandler 接口，它定义了两个方法：
| • |
LoadPostData — 该方法处理您控件的回发数据。 |
| • |
RaisePostDataChangedEvent — 该事件通知应用程序由于处理回发数据，该控件的状态已经更改。 |
PostDataChangedEvent 调用引发的事件必须在该控件内部定义。然后，用户可以在开发过程中编写实际的事件方法。
非回发事件
某些服务器控件支持非回发事件。此类事件会更改控件的状态，但并不要求立即进行处理。这些事件由控件缓存，而不是立即传递到服务器以进行处理。例如，ListBox 控件可能包含很多元素。如果用户选择一个不同的元素，那么控件将在不通知服务器的情况下显示适当的更改并记住其新状态。在张贴包含 ListBox 的窗体之后，ListBox 控件将提交事件（选定的项）。
非回发事件的默认行为可以通过设置 AutoPostBack 属性进行更改。如果 AutoPostBack 设置为 true，那么通常由客户端缓存的事件发送信号通知服务器立即进行处理。启用 AutoPostBack 的控件要求客户机允许运行脚本。
ASP.NET 2.0 并未以任何明显的方式更改该模型。
回调和带外请求
标准的 Web 协议设计用于同步通讯。每个请求接收响应的速度与服务器生成数据的速度同样快。但是，很多任务都需要带外 请求，例如同一时间访问第三方资源。这些请求未处于浏览器和 Web 服务器之间的标准通讯带区内，因此被认为是带外请求。
ASP.NET 1.x 中的带外
进行带外数据请求的要求提示众多开发人员可以创造性地使用可用资源来获得所需的功能。例如，通过使用 ActiveX 组件和 JavaScript，开发人员能够进行外部 HTTP 调用而无需完全回发到服务器。下面的 JavaScript 示例说明了可以与 ASP.NET 1.x 一起使用的带外 HTTP 请求。
function RetrieveGoogleFrontPage() {
var XmlHttp = new ActiveXObject("Msxml2.XMLHTTP.4.0");
XmlHttp.Open("GET", "http://www.fakedomain.com", false);
XmlHttp.Send();
return XmlHttp.responseText;
}
这种机制的一个缺点就是 XmlHttp.responseText 包含该请求的完整结果。开发人员将必须编写只返回商业数据的特殊页面，否则响应会由于不必要的标记而非常庞大。
ASP.NET 2.0 中的带外
ASP.NET 2.0 概括了 XmlHttp 对象的使用并提供了内置的回调功能。新系统的核心有两个关键项：System.Web.UI.ICallbackEventHandler 和 Page.GetCallbackEventReference 方法。
Page.GetCallbackEventReference 方法及其重载用于指定将参与回调事件的 JavaScript 方法。
public string GetCallbackEventReference(
Control control,
string argument,
string clientCallback,
string context
);
上述代码显示了 GetCallBackEventReference 所需的最小参数集，这些参数将在下面进行详细说明。
| • |
Control — control 参数确定实现 RaiseCallbackEvent 方法的 ICallbackEventHandler。 |
| • |
Argument — argument 字符串包含客户端脚本。评估该脚本的结果将作为 eventArgument 参数传递到 RaiseCallbackEvent。 |
| • |
ClientCallback — clientCallback 参数包含客户端事件处理程序的名称，该处理程序将接收成功服务器事件的结果。 |
| • |
Context — context 参数包含一个客户端脚本。评估该脚本的结果将传递到客户端事件处理程序，该处理程序在 clientCallback 参数中指定为 context 参数。 |
CallbackEventHandler 和 GetCallbackEventReference 方法相结合在客户端和服务器之间产生异步通讯。
回调示例
以下 Web 页使用回调机制查询服务器以获得其当前时间。该页面弹出一个 JavaScript 警告，在无需完整页面回发的情况下显示当前时间。
<%@ Page Language="C#" CompileWith="Default3.aspx.cs"
ClassName="Default3_aspx" %>
<%@ Register TagPrefix="cc1"
Namespace="MyControls"
Assembly="WebControlLibrary3" %>
<!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" >
<head runat="server">
<script language="javascript">
function GetServerTime() {
var message = '';
var context = '';
<%=CallBack%>
}
function ShowServerTime(timeMessage, context) {
alert('The time on the server is:\n' + timeMessage);
}
function OnError(message, context) {
alert('An unhandled exception has occurred:\n' + message);
}
</script>
</head>
<body>
<form id="form1" runat="server">
<div>
<cc1:timesnap id="TimeSnap1" runat="server"> </cc1:timesnap>
<input type="button" value="GetTime"
onclick="GetServerTime();" />
</div>
</form>
</body>
</html>
上述页面源代码包含三个关键 JavaScript 函数：GetServerTime()、ShowServerTime() 和 OnError()。这些 JavaScript 函数与页面的 GetCallbackEventReference 带外请求相关联。
public partial class Default3_aspx {
public string CallBack;
void Page_Load(object sender, EventArgs e) {
CallBack = this.GetCallbackEventReference(TimeSnap1,
"message","ShowServerTime","context","OnError");
}
}
GetCallbackEventReference 方法需要为其第一个参数实现 ICallbackEventHandler 接口的对象。通过实现 RaiseCallbackEvent() 方法，TimeSnap 自定义服务器控件符合接口要求。
public class TimeSnap : WebControl, ICallbackEventHandler
{
...
public string RaiseCallbackEvent(string eventArgument) {
// Uncomment next line to test error handler
// throw new ApplicationException(
// "Some unhandled exception");
return DateTime.Now.ToLocalTime().ToShortTimeString();
}
}
}
TimeSnap.RaiseCallbackEvent() 方法仅返回 string 格式的当前时间。
图 9. 回调请求输出
图 9 说明了按下 GetTime 按钮的结果。向服务器发出带外请求，从而产生显示服务器上当前时间的“Alert”窗口。发出这个请求不需要回发，因此控件的最初生成时间不会改变。
使用设计器
在前面的示例中，我们已经使用了几个标准的特性来规定自定义控件的属性将与设计器 (Visual Studio) 进行交互的方式。我们为各种控件属性分配了特性以定义属性将在其中出现的类别、定义属性是否应该具有一个默认值、定义属性的说明应该是什么样子以及属性是否应该为 bindable。在 ASP.NET 1.x 中，附加的设计器类 使您可以创建用于编辑属性的新对话框、自动将属性值从 String 转换为其他数据类型（反之亦然），并显示只在运行时生成的控件的占位符数据。
设计器类有助于将控件开发分成两个阶段。第一，您必须开发自定义控件。第二，您必须决定开发人员将如何与设计环境内的控件进行交互。设计器类通过在每个自定义控件的顶部充当装饰师来完成第二个任务。换句话说，如果您要开发很多自定义控件，您可以创建一个标准的可重复使用的设计器集，并通过特性简单地将设计器应用到每个自定义控件中。
ASP.NET 2.0 为设计器模型提供了几项增强功能：
| • |
新的复合控件设计器 — CompositeControlDesiger 类完全识别复合控件，并且提供支持父子控件关系的功能。 |
| • |
新的数据绑定控件设计器 — DataBoundControlDesigner 为 Databound 控件提供了很多新功能。您可以使用该设计器来提供模拟数据，或者在设计期间自动连接到活 datasource。 |
| • |
增强的备用设计时区域支持 — 新的 DesignerRegion 类及其子类提供了一种非常灵活的机制以便显示控件。您可以使用 DesignerRegion 来设置控件的选项卡式视图。您还可以使用 EditableDesignerRegion 控件为控件创建新的模板。 |
| • |
增强的模板支持 — 现在，设计器类提供了更简洁的机制以便将新的模板添加到控件中。模板化控件是一种将控件逻辑和控件显示分开的控件。显示通过模板进行定义，而逻辑在实际控件中进行编码。 |
| • |
增强的任务支持 — 现在，设计器可以合并设计时的任务。最常见的任务将可在视图之间切换。但是，其他任务可以包括控件的自动配置或资源文件的自动创建。任务可以在设计时控件上显示为菜单（与允许您配置 GridView 控件的菜单相似）。 |
| • |
增强的事件支持 — 设计器中的事件模型已经进行了改进。现在，您可以创建事件来响应在不同区域中的单击或对各种任务的单击。使用设计器时，只要用户在特定区域上单击就可以使控件切换视图、自动生成代码或更改配置。 |
ASP.NET 2.0 具有一个经过显著改进的设计器模型，它可以使专业控件开发人员的工作更加简单。如果您只是为自己使用而构建一个单个的控件，该设计器就大材小用了。但是，如果您要为分发而构建一个控件，您可以使用新的设计器来全面地自定义 Visual Studio 2005 中控件的行为。
小结
尽管 ASP.NET 2.0 包含了一个内容丰富的扩展控件集，但开发人员通常有很多理由来创建自定义控件。由于 ASP.NET 2.0 中的增强功能，创建自定义控件的过程要比在 ASP.NET 1.x 中更快、更容易。新的 CompositeControl 基类完全利用自适应呈现模型，并为创建复杂的控件提供了一个简单、易于使用的容器。如果您的控件需要回发或回调功能，ASP.NET 2.0 简化了处理客户端脚本文件和开发带外请求的过程。最后，在您开发控件后，您可以使用各种设计器类来完全配置控件在可视化设计器（例如 Visual Studio 2005）内的行为。
相关书籍
关于作者
Jayesh Patel — Jay Patel 是 .NET 和 Java 技术的开发人员。Jay 的研究重点在于基于编程的模式和灵活方法。
Bryan Acker — Bryan Acker 是 Infusion Development 的技术编写人员。Bryan 在 ASP、ASP.NET Web 开发和 Web 宿主方面有非常深厚的背景。
Robert McGovern — Rob McGovern 是一名资深作家、开发人员并且是 Infusion Development 的项目经理。Rob 参加过数个不同的 ASP.NET 项目，包括“CodeNotes for ASP.NET”和“The JSP to ASP.NET migration guide”。
Infusion Development Corporation 是 Microsoft 认证的解决方案提供商，为跻身财富杂志 1000 强的公司提供自定义软件开发、培训和咨询服务，主要对金融服务行业提供上述服务。基于在纽约和多伦多的办事处，Infusion Development 已经建立了一个国际化的客户基地，其中包括一些世界最大的金融服务、证券经纪和软件开发行业的公司。Infusion Development 的员工同时还是 CodeNotes 系列书籍的作者和创始者。
