从 ASP.NET 服务器控件插入客户端脚本

javaGrowing — Thu, 05 Jan 2006 07:14:00 GMT

从 ASP.NET 服务器控件插入客户端脚本

Scott Mitchell

2003 年 8 月

适用于：
Microsoft® ASP.NET

前提条件：本文假设读者熟悉 ASP.NET。

难度： 2

摘要：尽管从技术角度讲，ASP.NET 服务器控件的所有功能都可以在服务器端执行，但通常情况下通过添加客户端脚本可以大大增强服务器控件的可用性。本文将探讨服务器控件发送客户端脚本的两种方法，还将构建两个使用这些技术的服务器控件：PopupGreeting，一个在首次加载的 Web 页面上显示带有特定消息的客户端模式对话框的服务器控件；ConfirmButton，一个增强的 Button Web 控件，如果用户点击此按钮，则在发回 Web 窗体前向用户显示一个 JavaScript confirm() 的对话框。（本文包含一些指向英文站点的链接。）

下载 InjectingClientSideScript.msi。

尽管从技术角度讲，Microsoft® ASP.NET 服务器控件的所有功能都可以在服务器端执行，但通常情况下通过添加客户端脚本可以大大增强服务器控件的可用性。例如，ASP.NET 验证 Web 控件可以在服务器端执行所有的验证检查。但是，对于高版本浏览器，验证 Web 控件也会发送客户端脚本，以在客户端进行验证。这就是说，这些浏览器的用户可以获得响应效果更好的动态体验。

在开发 ASP.NET 服务器控件时，您不妨问问自己，如何才能通过使用客户端脚本来增强可用性。一旦找到可行的方案，其他要做的就是增强服务器控件的功能，以使其发送合适的客户端脚本。

ASP.NET 服务器控件可以发送两种客户端脚本：

客户端脚本块
客户端 HTML 属性

客户端脚本块通常是用 JavaScript 编写的，其中通常包含在发生特定的客户端事件时执行的函数。客户端 HTML 属性提供将客户端事件与客户端脚本联系在一起的方法。例如，以下的 HTML 页面中包含了客户端脚本块，脚本块中包含了名为 doClick() 的函数。该页面同时还包含一个按钮（通过 HTML 元素创建），这个按钮的 onclick 属性与 doClick() 函数绑定。也就是说，只要用户单击该按钮，就开始执行 doClick() 函数中的客户端代码。在本示例中，将显示一个弹出式对话框（图 1）。

图 1 是单击“Click Me!”按钮时 HTML 页面的屏幕快照。

图 1：单击“Click Me!”按钮时显示的弹出式对话框

对于以上 HTML 页面中的客户端脚本，有几点值得注意。首先，客户端脚本块包含在 HTML 注释（）中。之所以这样，是因为如果不将脚本块放入 HTML 注释中，那些不能识别脚本的旧式浏览器就会显示

在这段代码中，标记中的 onclick="displayPopup()" 用于指明在单击按钮时，JavaScript 函数 displayPopup() 应该运行。


RegisterStartupScript()
方法可用于添加要在加载页面后运行的脚本块。通过这种方法添加的脚本块位于 Web 窗体的结尾处，因为必须在脚本运行前定义脚本要修改的 HTML
元素。也就是说，如果您要使用客户端脚本将焦点设置到文本框，必须确保文本框的 HTML 标记位于设置该文本框的焦点的脚本之前。例如，下面的
HTML 将显示一个文本框，并将焦点设置到该文本框：




相反，以下 HTML 不会将焦点设置到文本框，因为文本框是在脚本块“之后”定义的：




因此，RegisterStartupScript() 方法将 ";
            scriptBlock = scriptBlock.Replace("%%POPUP_MESSAGE%%", this.PopupMessage);

            Page.RegisterStartupScript(scriptKey, scriptBlock);
         }
      }
   }
}

请记住下面两件事：首先，Enabled 和 PopupMessage 属性保存在 ViewState 中，这样在回传时这些值可以始终保持一致； 其次，在 OnPreRender() 方法中，用于脚本块的关键字是文本 intoPopupMessage: 加上控件的 UniqueID 属性。如果使用一个硬编码的关键字，则当页面中有多个控件时，只有第一个控件能够注册其脚本块，因此只显示一个弹出式对话框。通过在脚本块关键字中使用 UniqueID，就能保证该控件的每个实例都能获取其脚本块。

在注册脚本块之前，代码首先检查三个条件：
没有使用同一关键字注册的脚本。这当然是不可能的，因为每个控件实例都应该有一个 UniqueID 属性值。但是，不妨先练习使用 IsStartupScriptRegistered() 方法，然后再花时间创建和注册启动脚本。 
控件的 Enabled 属性为 True。 
页面没有被回传。这段代码只允许弹出式对话框在第一次加载页面时显示，而不是在每次回传页面时都显示。我们还可以增添更为灵活的功能，即为该控件添加一个布尔属性，以允许用户指定是否在回传时也生成弹出式对话框。
如果满足这三个条件，则脚本被指定，并且 PopupMessage 属性值被插入到脚本中适当的位置。最后，调用 Page 属性的 RegisterStartupScript() 方法，传入关键字及脚本代码。
PopupGreeting 代码可以从本文结尾处提供的下载中获得。该下载包括名为 ClientSideControlsAndTester 的 Visual Studio .NET 解决方案，其中包含两个项目：
ClientSideControls，包含 PopupGreeting 服务器控件 
ClientSideTester，包括一个为测试 ClientSideControls 而设计的 ASP.NET Web 应用程序 
ClientSideControls 项目编译后的程序集名为 ClientSideControls.dll。要在您自己的 ASP.NET Web 应用程序中使用 PopupGreeting 服务器控件，请将 ClientSideControls.dll 文件添加到您的 Web 应用程序的引用中。然后，在设计器中，右键单击 Toolbox（工具箱）并选择“Add/Remove Items . . .”（添加/删除项），再次选择 ClientSideControls.dll 文件。这样就向 Toolbox（工具箱）中添加了名为 PopupGreeting 的新项。然后，您可以从 Toolbox（工具箱）将该控件拖到设计器中。
图 2 显示了 PopupGreeting 控件添加到 Toolbox（工具箱）并添加到设计器后，Visual Studio .NET
的屏幕快照。Toolbox（工具箱）中的 PopupGreeting 控件用红色线圈出，设计器中的 PopupGreeting
输出用蓝色线圈出，在屏幕快照右侧的“Properties”（属性）窗格中可以查看 PopupGreeting 的属性。

图 2：PopupGreeting 服务器控件已添加到 ASP.NET Web 窗体页面
发送 ASP.NET 服务器 Web 控件的 HTML 属性 
如上所述，有两种方法可以通过服务器控件发送客户端脚本：
通过使用客户端脚本块 
通过 HTML 元素属性 
在上一节中，我们探讨了如何使用 Page 类的 RegisterStartupScript() 和 RegisterClientScriptBlock() 方法向 ASP.NET Web 页面添加客户端脚本块。在最后这一节，我们了解如何将 HTML 元素属性添加到服务器控件的 HTML 元素。
在开始之前，请注意这种方法通常只适用于从 System.Web.UI.WebControls.WebControl 类导出的服务器控件，因为从这个类导出的控件会发送某些 HTML 元素。不发送 HTML 元素的服务器控件（如上一节中的 PopupGreeting 服务器控件），则不必写出 HTML 元素属性，因为这些控件运行时不会写出 HTML 元素。
WebControl 类包含一个将 HTML 元素属性添加到由 Web 控件发出的 HTML 元素的方法。该方法称为 AddAttributesToRender()，它只有一个输入参数，即 HtmlTextWriter 的实例。要向 Web 控件添加 HTML 属性，您可以使用 HtmlTextWriter 的以下两个方法之一：
AddAttribute() 
AddStyleAttribute() 
AddAttribute() 方法用于将 title、class、style 和 onclick 等 HTML 属性添加到 HTML 元素。AddStyleAttribute() 用于将样式设置添加到 HTML 元素，如 background-color、color 和 font-size 等。
AddAttribute() 有几个重载窗体，但在代码中，我们将使用以下窗体：AddAttribute(HtmlTextWriterAttribute, value)。第一个参数，即 HtmlTextWriterAttribute，应该是 HtmlTextWriterAttribute 枚举的成员。该枚举包含像 Align、Bgcolor、Class 和 Onclick 等项。您可以在 .NET Framework Class Library，HtmlTextWriterAttribute Enumeration 中找到完整的列表。value 输入参数用于指定分配给特定 HTML 属性的值。最后，如果您想添加一个 HtmlTextWriterAttribute 枚举中未定义的 HTML 属性，可以使用 AddAttribute() 方法的替代形式 AddAttribute(attributeName, value)，其中的 attributeName 和 value 均为字符串。
为了运用该信息，我们创建一个作为确认按钮的服务器 Web
控件。确认按钮是一种提交按钮，当用户单击此按钮时，将显示一个弹出式对话框，询问用户是否确定要继续操作。用户可以单击“取消”，不提交窗体。此项功能
对用于删除信息的按钮特别有用，因为最终用户（或网站管理员）可能会在无意中单击鼠标删除数据库中的条目，如果没有机会取消，将是非常令人烦恼的事。
为了减少工作量，我们从 System.Web.UI.WebControls.Button 类中导出 ConfirmButton Web 控件，因为这个类本身已完成了涉及呈现提交按钮的所有繁重工作。在导出的类中，我们只需添加一个属性，这样用户可以指定确认消息，然后覆盖按钮的 AddAttributesToRender() 方法，并添加一个属性以处理客户端事件 onclick。
首先，在 Visual Studio .NET 中创建一个新的 Web Control Library（Web 控件库）项目，或者在
ClientSideControls 项目中添加一个新的 Web Custom Control（Web
自定义控件）。ConfirmButton 类的完整源代码如下所示：
using System;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.ComponentModel;

namespace ClientSideControls
{
   /// 
   /// ConfirmButton 的摘要描述。
   /// 

   [DefaultProperty("Text"), 
      ToolboxData("<{0}:ConfirmButton runat=server>")]
   public class ConfirmButton : Button
   {
      [Bindable(true), 
         Category("Appearance"), 
         DefaultValue("")] 
      public string PopupMessage
      {
         get
         {
            // 检查 ViewState 中是否存在该项目
            object popupMessage = this.ViewState["PopupMessage"];
            if (popupMessage != null)
               return this.ViewState["PopupMessage"].ToString();
            else
               return "Are you sure you want to continue?";
         }

         set
         {
            // 指定 ViewState 变量
            ViewState["PopupMessage"] = value;
         }
      }


      protected override void AddAttributesToRender(HtmlTextWriter writer)
      {
         base.AddAttributesToRender(writer);

         string script = @"return confirm(""%%POPUP_MESSAGE%%"");";
         script = script.Replace("%%POPUP_MESSAGE%%", 
            this.PopupMessage.Replace("\"", "\\\""));

         writer.AddAttribute(HtmlTextWriterAttribute.Onclick, script);
      }
   }
}

首先要注意的是，ConfirmButton 类是从 Button 类导出的。由于 Button 类已包含 Button Web 控件使用的所有属性和方法，因此我们所做的只是添加属性和方法，以在用户单击按钮时显示一个确认对话框。现在我们需要一个属性，即 PopupMessage，
它是要在确认弹出式对话框中显示的消息。默认情况下，这条消息是“Are you sure you want to
continue?”（您确定要继续吗？）如果使用 ConfirmButton 来确认删除，可能需要将该消息更改为“This action
will permanently delete the selected item. Are you sure you want to do
this?”（此操作将永久删除所选项。您确定要继续吗？）
我们只需覆盖一个方法，即 AddAttributesToRender()。在此方法中，我们只要构建当触发  元素的 onclick 事件时要执行的客户端 JavaScript，然后通过传入的 HtmlTextWriter 对象的 AddAttribute() 方法添加这段 JavaScript。关于这个方法，有一点要注意，必须将 PopupMessage 属性值中的所有双引号实例替换为转义双引号（即 \"）。另外还要注意，默认情况下，AddAttribute() 会对第二个参数中的字符进行 HTML 编码。也就是说，ASP.NET Web 页面中如果包含 PopupMessage 属性被设置为“Do you want to continue?”（要继续吗？）的 ConfirmButton，该页面将发送以下 HTML 标记：
value="Click Me!" id="ConfirmButton1" onclick="return confirm
("Do you want to continue?"" />

如果您不熟悉 JavaScript 的 confirm(string) 函数，那么请您注意，该函数只接受一个字符串参数，并显示一个带有特定字符串的模式对话框。该对话框中包含两个按钮：“确定”和“取消”。如果单击“确定”，confirm() 函数返回 True，否则返回 False。请注意，onclick 事件将返回 confirm() 函数调用的结果。当通过单击提交按钮来提交表单时，如果提交按钮的 onclick 事件返回 False，则表单未被提交。因此，只有在用户确认后，可以使用 confirm() 函数提交表单。有关 confirm() 的详细信息，请参阅 ASP Warrior 网站中的 Javascript Confirm Form Submission。

图 3：操作中的 ConfirmButton
ConfirmButton 在按钮的 onclick 事件处理程序中使用了内嵌的 JavaScript，还可以在 ConfirmButton 的 OnPreRender() 方法的客户端脚本块中创建一个函数，然后调整 onclick 属性以调用该函数。
小结 
在本文中，我们探讨了两种通过 ASP.NET 服务器控件插入客户端脚本的方法。第一种方法是使用 Page 类的 RegisterStartupScript() 和 RegisterClientScriptBlock() 方法插入客户端脚本块。第二种方法是向 HTML 元素的属性添加客户端脚本。后者通过覆盖 Web 服务器控件的 AddAttributesToRender() 方法，并使用 HtmlTextWriter 的 AddAttribute() 方法来完成。
我们还在文中介绍了两个简单的服务器控件，它们都利用了客户端脚本来改进其功能。PopupGreeting 控件在页面首次加载时显示一个模式弹出式对话框，ConfirmButton Web 控件在用户单击按钮提交表单时，提示用户进行确认。
您可以在自己的服务器控件中插入客户端脚本，这将显著改善用户体验。本文提供的两个服务器控件相对比较简单，在可用性和独创性上没有什么突出之处。MetaBuilders.com
中展示了很多利用从 ASP.NET 服务器控件中插入客户端脚本而实现的功能，这些功能会给您留下深刻印象。在
MetaBuilders.com，您可以找到一些服务器控件，它们有的可以自动将焦点添加到文本框，有的可以在两个下拉列表之间传递条目，有的可以向下
拉列表中添加或删除条目，还有的可以在一系列下拉列表中显示父子关系的数据，等等。最大的好处是，这些控件是免费的，并包括完整的源代码。
祝大家编程快乐！
作者简介
Scott Mitchell 著有五本关于 ASP/ASP.NET 的书籍，是 4GuysFromRolla.com
网站的创始人，过去五年来一直从事 Microsoft Web 技术方面的研究。Scott 是 ASP 和 ASP.NET
社区非常活跃的一名成员，十分热爱 ASP 和 ASP.NET 技术，并非常愿意帮助其他人了解这些令人振奋的技术。有关
DataGrid、DataList 和 Repeater 控件的详细信息，请参阅 Scott 的著作《ASP.NET Data Web
Controls Kick Start》（ISBN 为 0672325012）。
推荐链接：
MetaBuilders.com 客户端 Web 控件 
.NET Framework Class Library，Page.RegisterClientScriptBlock Method Technical Documentation 
.NET Framework Class Library，Page.RegisterStartupScript Method Technical Documentation 
Visual Studio Magazine，Implement Client Scripts 
ASP.NET Forums 的 Building Controls Forum 


javaGrowing 2006-01-05 15:14 发表评论

BlogJava-javaGrowing-随笔分类-asp.net

从 ASP.NET 服务器控件插入客户端脚本

目录

作者简介

推荐链接：

ASP.NET Web 页面生命中的一天

目录