★★★【庖丁解牛：纵向切入Asp.net 3.5控件和组件开发技术系列—(5)事件和数据回发机制】★★★...

<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

第5章庖丁解牛系列—事件和数据回发机制

本章内容

5.1 控件事件和数据回发概述

5.2 事件和数据回发机制的实现

5.3 复合控件的事件处理机制

[点击下载本书word格式完整目录介绍]

5.1 控件事件和数据回发概述

在讲解实现控件事件和数据回发功能之前，有必要先了解一下相关的基本概念。

5.1.1 事件及其意义

要为控件定制事件，先得使用控件的事件。首先以经典的Button控件的OnClick事件为例子，说一下事件的使用模型。

1．注册事件

<asp:Button ID="Button1" runat="server"OnClick="Button1_Click"Text="Button"/>

u 或在Page_Load中注册：

protected void Page_Load(object sender, EventArgs e)

{

this.Button1.Click +=new EventHandler(Button1_Click);

}

2．事件方法体

protected void Button1_Click(object sender, EventArgs e)

{

}

首先从事件要实现的功能角度理解事件。我们把按钮（Button）看做一个对象，把页面（Page）也看做一个对象。

正向理解：假如我们在Page对象中要修改Button的行为，可以直接通过this.Button1的形式直接访问Button对象的属性或方法对Button进行修改，可以理解为Page类能访问到Button代码功能。原因是Button1是Page类内部的一个对象，类当然可以直接访问其内部的对象。

逆向理解：假如我们需要在Button中要访问Page中的代码呢？直接像上面那样通过this.Page的形式是不行的，因为Button是Page类的内部对象，但Page不是Button类的内部对象，从面向对象角度讲，类（Button）不能访问其外部的对象（Page），也就是说在Button中不可能通过this.Page的形式访问到Page对象。而使用事件机制就可以解决此问题，即事件机制解决了面向对象编程中不允许类访问类外部代码问题。关于事件的应用本章后面会专门讲解，在这里仅介绍一下它的功能。

更深层了解一下Button的事件：假如我们没有对Button注册Click事件，则Button会执行一遍它内部的Click相关逻辑，并没有对Page对象产生任何影响；如果我们为Button定义了Click事件（如上面代码片段），则Button还是执行一遍它内部的Click相关逻辑，不同的是在执行自己内部逻辑的过程中它还执行了Page对象中的一些代码功能（即Button的事件体Button1_Click方法），就达到了我们要实现的功能。通过触动一个对象Button影响到另一个对象Page的行为，并且在Button的事件体中即可以修改Button本身（通过sender或this.Button1），也可以修改Page页面对象的其他控件或执行任意想要的代码功能。

其次从ASP.NET工作机制说一下它的工作原理，与桌面应用程序中的事件不同，ASP.NET服务器控件事件是在服务器上引发和处理的。当Web请求将客户端操作发送到服务器时，控件可以在服务器上引发事件来响应客户端操作。该页或其子控件对事件进行处理，然后ASP.NET将响应发送回客户端。这样，用户感觉就像在使用桌面应用程序一样。但是，控件开发人员必须了解只有一个客户端事件发送到服务器，即回发事件。

有些在客户端执行的事件（如JavaScript定义的客户端事件）没有被发送到服务器，不能被服务端处理，这样的事件不是我们这一章要讲的事件，本章讲的是服务器控件事件，是由服务器来处理的事件。

5.1.2 数据回发机制

在ASP.NET技术的服务器编程中，服务器处理完客户端的每个请求就认为任务结束，当客户端再次请求时，服务器会作为新的一次请求处理，即使是相同的客户端也是如此。也就是说服务器不会保存我们两次请求之间的一些前后相接的数据，这就比较麻烦了，比如当我们输入一些信息到一个文本中，然后提交一个按钮，很多时候我们要在按钮提交的服务端事件中处理提交之前的数据和提交按钮时用户输入的最新数据，即想同时得到文本框的旧值和新值，而服务端不会保存前一个请求的任何信息，那怎样才能做到这一点呢？

两次页面请求之间的数据关联性问题，ASP.NET是通过视图机制实现的。简单地讲，视图区域信息（ViewState）存储在页面上的一个隐藏字段，里面存储每次需要视图机制保存的一些信息，每次提交时，它都会以“客户端到ó服务端”的形式来回传递一次，当处理完成后，最后会以处理后的新结果作为新的视图信息存储到页面中的隐藏字段，并与页面内容一起返回到客户端。后面会有针对视图状态机制的专门讲解，这里仅了解其功能即可。

有了视图机制，在其基础之上的数据回发机制就是完成处理视图信息的功能。具体过程是，服务端控件只要实现IPostBackDataHandler接口，则当客户端提交请求后，就会有机会利用IPostBackDataHandler接口的LoadPostData方法，在该方法内部处理子控件的新旧值逻辑，而视图信息数据这时以一个集合对象形式作为LoadPostData参数，并可以决定是否引发控件值变化后的事件。这就是要引入数据回发机制功能的原因。

通过上面两小节的讲解，您应该对事件和数据回发机制有了比较系统的认识。这样会较容易理解接下来要讲的事件和数据回发机制的具体使用和实践部分内容。

5.2 事件和数据回发机制的实现

5.2.1 客户端回传事件接口IPostBackEventHandler

要使控件捕获回发事件，控件必须实现System.Web.UI.IPostBackEventHandler 接口。此接口约定允许控件在服务器上引发事件来响应来自客户端的回发。IPostBackEventHandler接口包含一个方法。

1. ///<summary>
3. ///获得本书更多内容,请看:
5. ///http://blog.csdn.net/ChengKing/archive/2008/08/18/2792440.aspx
7. ///</summary>
9. publicinterfaceIPostBackEventHandler
11. {
13. voidRaisePostBackEvent(stringeventArgument);
15. }

参数

eventArgument 表示要传递到事件处理程序的可选事件参数，一般通过此参数可以确定不同的引发事件源，进而作不同的逻辑处理。在本章最后有个例子说明 eventArgument 参数用法。回发后，页框架就会搜索发送的内容，并确定发送的名称是否与实现 IPostBackEventHandler 的服务器控件的 UniqueID 对应。如果对应，页框架就会在该控件上调用 RaisePostBackEvent 方法（在引发更改事件后）。

以下代码片段显示了在服务器上引发Click事件的RaisePostBackEvent实现：

1. ///<summary>
3. ///获得本书更多内容,请看:
5. ///http://blog.csdn.net/ChengKing/archive/2008/08/18/2792440.aspx
7. ///</summary>
9. publicvoidRaisePostBackEvent(StringeventArgument)
11. {
13. ButtonEventArgse=newButtonEventArgs(eventArgument);
15. OnClick(this,e);
17. }

在该方法中主要完成调用

OnClick(e) 事件功能，其中包含两个参数：第一个参数为当前控件本身（即一般事件体中 sender ，类型一般为 object ）；第二个参数 e 为 ButtonEventArgs 参数类型对象，是继承于 System.EventArgs 类实现的参数类，在该类中可以定义与代码逻辑相关的任意属性，作为事件体的参数。

最后，RaisePostBackEvent需要被客户端引发才能够执行，下面是一段能够引发服务端事件的代码：

1. ///<summary>
3. ///获得本书更多内容,请看:
5. ///http://blog.csdn.net/ChengKing/archive/2008/08/18/2792440.aspx
7. ///</summary>
9. protectedoverridevoidRender(HtmlTextWriteroutput)
11. {
13. output.Write("<INPUTTYPE=submitname="+this.UniqueID+
15. "Value='ClickMe'/>");
17. }

这段代码输出一个HTML的button标签，并设置为提交类型。非常重要一点是，不要忘记设置其name属性，因为当回发后，页框架就会搜索发送的内容，并确定发送的名称是否与实现IPostBackEventHandler的服务器控件的UniqueID对应。如果对应，页框架就会在该控件上调用RaisePostBackEvent方法；反之，如果没有设置按钮的name值为UniqueID属性值，当单击按钮时页框架就不会引发该控件的RaisePostBackEvent方法，因为只有名称为UniqueID（服务器控件服务端ID）的按钮才会被注册为具有IPostBackEventHandler接口功能的控件。

下面通过一个简单的完整例子，了解事件回发处理机制，代码如下：

1. ///<summary>
3. ///获得本书更多内容,请看:
5. ///http://blog.csdn.net/ChengKing/archive/2008/08/18/2792440.aspx
7. ///</summary>
9. [DefaultEvent("Click")]
11. [ToolboxData("<{0}:PostBackEventControlrunat=server></{0}:PostBackEventControl>")]
13. publicclassPostBackEventControl:Control,IPostBackEventHandler
15. {
17. publiceventEventHandlerClick;
19. protectedvirtualvoidOnClick(EventArgse)
21. {
23. if(Click!=null)
25. {
27. Click(this,e);
29. }
31. }
33. publicvoidRaisePostBackEvent(stringeventArgument)
35. {
37. OnClick(EventArgs.Empty);
39. }
41. protectedoverridevoidRender(HtmlTextWriteroutput)
43. {
45. output.Write("<INPUTTYPE=submitname="+this.UniqueID+"Value='单击我'
47. />");
49. }
51. }

该

控件内容比较简单，仅输出一个提交类型的按钮，由于这个按钮类型为 submit ，所以当单击按钮时，其本身已经可以提交事件到服务器，但仅仅这样主控件还不能够捕捉到该按 钮事件。控 件能够捕捉处理该事件需要具备两个条件：第一，主控件继承了 IPostBackEventHandler 接口以及实现了 RaisePostBackEvent 方法；第二，必须有 name 值为 UniqueID 的客户端标签，页框架只认识控件的 name 属性。只有这两个条件同时具备才能够使控件具备捕捉并处理事件的机会。

语句[DefaultEvent("Click")]的功能是定义Click事件为默认事件。通常把最常用的一个事件定义为默认事件，如果定义了默认事件，在设计器中双击控件时系统会自动从源代码视图（*.aspx）切换到后面代码（*.cs）页面，并可以自动注册默认事件；否则，仅切换到后台代码，但不注册任何事件。

类代码中最上面的一句：

public event EventHandler Click;

这条语句定义了一个委托事件。EventHandler是一个预定义的委托，专用于表示不生成数据的事件的事件处理程序方法。如果事件生成数据，则必须提供自定义事件数据类型，并且必须要么创建一个委托（其中第二个参数的类型为自定义类型），要么使用泛型EventHandler委托类并用自定义类型替代泛型类型参数。

在5.1.1节讲过事件的意义及其完成的功能，即在一个类中执行另一个功能类的功能，要想执行另一个类中的某个功能方法，必定要在当前类中保留另一个方法的引用，委托和事件就是为实现此功能而出现的。委托类似于C++中的函数指针，它一般指向一个方法。这样，当调用本类中的委托就相当于调用了另一个类中的方法。

若要将事件与处理事件的方法关联，请向事件添加委托的实例和委托事件实例，如：

this.Button1.Click +=new EventHandler(Button1_Click);

除非移除了该委托，否则每当发生该事件时就调用事件处理程序。

另外，委托的应用比较广泛，还有更加复杂的应用，比如定义一个委托可以同时指向多个事件，即一个委托指定一个事件列表，当调用委托时可以执行一系列的事件。这里限于篇幅就不多讲了，更多关于事件委托概念请查看微软官方文档，那里面已经讲得很详细了。

5.2.2 客户端回发/回调揭密

对于服务端控件元素，比如ASP.NET的Button标准服务端控件在提交时可以自动把请求发送到服务端处理，这样的控件我们不用自己处理它们的事件回发；但对于呈现不引起回发的HTML元素，如“文本框”（TextBox）或“链接按钮”（LinkButton），而希望由控件启动回发，则可以在ASP.NET中通过依靠客户端脚本的事件结构进行编程来实现这一功能。

完整地处理一个事件则还需要回发和捕捉。捕捉是IPostBackEventHandler接口的事情，上一节讲得比较清楚了，这一节主要讲回发（客户端回发请求到服务端）。

下面就以一些常用的HTML标记展开分析客户端回发机制，以及各种HTML标记的回发形式。

5.2.2.1 设置HTML Button标记的类型为submit

如上节的PostBackEventControl控件例子就是采用设置HTML Button标记的类型为submit的方式从客户端提交回发的。回发代码如下：

output.Write("<INPUT TYPE=submit name=" + this.UniqueID + " Value='单击我' />");

INPUT是标准的HTML标记控件，它默认情况下没有runat="server"，并且这些控件默认情况下只能处理一些客户端方法。INPUT的TYPE属性表示该标记的控件类型，如：type=button表示按钮；type=submit表示可提交表单功能的按钮；type=text表示文本框控件；type=file表示上传文件控件等。这里主要说明的是当type=submit类型的控件表示提交按钮时，它显示的样式与type=button的效果一样，不同的是单击它后可以提交表单到服务器，且不需要另外的代码，ASP.NET默认情况下是提交表单到当前页面。type=submit提交功能是从IE 3.0版开始支持的，只要浏览器版本不小于此版本都可使用该功能。

5.2.2.2 使用方法GetPostBackEventReference 得到回发脚本

1．为HTML客户端控件增加回发功能

一般页面中的按钮并不都是type=submit类型的，大部分是type=button类型的按钮，把上面5.2.2.1节的代码段中的type=submit修改成type=button，修改后的代码如下：

output.Write("<INPUT TYPE=button name=" + this.UniqueID + " Value='[使用提交按钮]' />");

u 由于此代码段中的按钮的type属性由sumbit改成了一般按钮类型button，则此按钮输出后将不再具有回发到服务端的功能。为了使一般按钮也具有回发的功能，ASP.NET提供了Page.ClientScript.GetPostBackEventReference方法。ClientScript类型为ClientScriptManager，该类主要功能是在Web应用程序中定义用于管理客户端脚本的方法。GetPostBackEvent Reference方法体结构如下：

GetCallbackEventReference(String, String, String, String, String, Boolean)

此方法功能是获取一个对客户端函数的引用；调用该方法时，将启动一个对服务器事件的客户端回调。此重载方法的客户端函数包含指定的目标、参数、客户端脚本、上下文、错误处理程序和布尔值。

在期望不执行回发而从客户端运行服务器代码的情况下，可以使用ClientScriptManager类来调用客户端回调。这称为对服务器执行带外回调。在客户端回调中，客户端脚本函数向ASP.NET网页发送异步请求。网页修改其正常生命周期来处理回调。使用GetCallbackEvent Reference方法获取一个对客户端函数的引用，当调用该函数时，它将启动一个对服务器端事件的客户端回调。

使用GetCallbackEventReference方法对上面代码增加回调客户端功能，修正后的代码如下：

output.Write("<INPUT type=button name=\"{0}\" value='[使用Page.ClientScript对象方法]' οnclick=\"{1}\">", this.UniqueID, Page.ClientScript.GetPostBackEvent Reference(this, ""));

Page.ClientScript.GetPostBackEventReference方法的第一个参数传递当前控件引用，在实际应用中可以传递任意控件引用，包括子控件；第二个参数为可选的命令参数，这里设置为null，一般同时处理多个按钮时可以设置该参数为不同的命令名称。

另外，Page.ClientScript对象还有个非常重要的方法GetCallbackEventReference。使用GetCallbackEventReference方法获取一个对客户端函数的引用，当调用该函数时，它将启动一个对服务器端事件的客户端回调，可以支持设置客户端回调方法名称等，在这里仅简单提一下，在后面还有专门章节介绍ASP.NET控件开发对客户端的支持。

转入正题，在代码中增加按钮的onclick单击事件，当单击按钮时会调用GetPostBackEvent Reference方法返回的一串客户端脚本，并且在页面中生成一个客户端方法和两个type=hidden的隐藏域控件。下面是以上代码呈现到客户端的HTML代码：

<INPUT type=button name="PostBackFromClientControl1"value='[使用Page. ClientScript对象方法]'οnclick="__doPostBack('PostBackFromClientControl1','')">

<div>

<input type="hidden" name="__EVENTTARGET" id="__EVENTTARGET" value="" />

<input type="hidden" name="__EVENTARGUMENT" id="__EVENTARGUMENT" value="" />

</div>

<script type="text/javascript">

//<![CDATA[

var theForm = document.forms['form1'];

if (!theForm) {

theForm = document.form1;

}

function __doPostBack(eventTarget, eventArgument) {

if (!theForm.onsubmit || (theForm.onsubmit() != false)) {

theForm.__EVENTTARGET.value = eventTarget;

theForm.__EVENTARGUMENT.value = eventArgument;

theForm.submit();

}

}

//]]>

</script>

从上面最终输出的HTML源代码可以看到，Button控件的单击事件会执行一个名为_doPostBack的方法，并且此方法也是自动生成在页面中的。在_doPostBack方法中把事件目标对象eventTarget（调用GetPostBackEventReference方法时传递的第一个参数，为当前控件）赋值给当前Form对象，把事件参数对象eventArgument（调用GetPostBackEventReference方法时传递的第二个参数），最后调用Form对象的提交方法，提交窗体，到这里就实现了我们想要的回发功能。

还要注意到以下两句自动生成的代码：

<input type="hidden" name="__EVENTTARGET" id="__EVENTTARGET" value="" />

<input type="hidden" name="__EVENTARGUMENT" id="__EVENTARGUMENT" value="" />

这是两个隐藏域类型控件，主要用来存储事件目标对象和事件参数对象的值。还有，在以上的script标记之间，有个嵌套的//<![CDATA[ //]]> 子句，该句与纯控件开发技术无关。该句的功能是通知HTML读取器下面这段不是HTML的内容，需要按附加的转义字符分开保存，以防代码解析出错。

2．为服务端控件生成回发脚本

Page.ClientScript.GetPostBackEventReference方法还可以为服务端控件生成自己的回发脚本，可以从客户端回发。

ASP.NET标准的Button服务端控件最终生成的HTML标记无非也是生成一个type=submit类型的控件。对于服务端控件也可以设置客户端回发功能。比如在使用Button控件时把UseSubmitBehavior属性设置为false，则禁用按钮的自动提交功能，就可以使用GetPostBackEventReference方法返回Button控件的客户端回发事件脚本，代码如下所示：

string strPostBackCode =

this.Page.ClientScript.GetPostBackEventReference(button1,”edit”);

u 然后把Button的客户事件与生成的回发事件脚本进行关联：

this.button1.Attributes[“onclick”] = strPostBackCode;

其他服务端控件也是这样设置的。

5.2.2.3 使用方法GetPostBackClientHyperlink得到回发脚本

这种方式的原理与GetPostBackEventReference类似。该方法的功能是获取一个脚本引用，与前者有一点区别是在其开头附加一个javascript: 前缀，该前缀属于JavaScript基本语法，常用来在非脚本语言（如HTML）源代码中告诉浏览器该前缀后面的格式串作为JavaScript脚本语言来解析，如：javascript:alert（‘hello’）即表示弹出一个“hello”对话框。该引用可在客户端事件中回发到指定控件的服务器，回发时使用指定的事件参数和一个布尔值指示是否为事件验证注册该回发。方法体结构如下：

GetPostBackClientHyperlink(Control, String, Boolean)

跟GetPostBackEventReference相同，第一个参数为事件目标对象；第二个参数为可选参数；第三个参数表示是否为验证注册回发事件。

下面看一个应用示例，代码如下：

string href = Page.ClientScript.GetPostBackClientHyperlink(this, "");

output.AddAttribute(HtmlTextWriterAttribute.Href, href);

output.RenderBeginTag(HtmlTextWriterTag.A);

output.Write("[使用Page.ClientScript对象的GetPostBackClientHyperlink方法]");

output.RenderEndTag();

u 与前面不同，这里是输出一个HTML的<a>标签。相信读者已经猜到GetPostBackClientHyperlink的应用场景了（通过方法名***Hyperlink就能够看得出它是专为哪个控件使用的功能）。直接看一下最终生成的客户端的HTML源代码：

<a href="javascript:__doPostBack('PostBackFromClientControl1','')">[使用Page.ClientScript对象的GetPostBackClientHyperlink方法]</a>

<div>

<input type="hidden" name="__EVENTTARGET" id="__EVENTTARGET" value="" />

<input type="hidden" name="__EVENTARGUMENT" id="__EVENTARGUMENT" value="" />