第3章 从零开始开发服务器控件

第3章从零开始开发服务器控件本章内容3.1选择基类3.2控件呈现顺序3.3Render呈现控件的几种方式3.4AddAttributesToRender方法3.5CreateChildControls方法3.6INamingContainer接口3.7实现复合控件3.8常用开发技巧3.1选择基类在开发一个控件之前要先选择控件开发要继承的基类，这些基类封装了控件最基本的功能，可以提高代码重用性，并且每个基类提供的功能不同，在第1章中已经列出了许多常用基类，如果您还不大清楚，请看一下第1章。这里仅谈一谈一般开发基本控件所选择基类的方式。Control控件开发基类，所有控件都直接或间接继承该类。提供了各类控件通用属性和方法，如唯一标志ID属性、可见性Visible等。该类仅具有控件最基本的属性，扩展灵活性最强。WebControlWebControl除了继承了Control的所有属性，还增加了布局、可访问性、外观样式等特性；另外，对行为也扩充了好多属性。Control和WebControl都用于开发简单控件（即单个控件或非组件控件）。一般在选择控件时，如果要开发的控件对外观布局和样式等控件特性要求比较高，则可以选择继承WebControl要方便得多；反之，选用Control实现即可。如果一定要选用Control实现WebControl的特性也是可以的，但要自己增加所需的属性，如布局属性width和height，实现起来会较麻烦。28庖丁解牛——纵向切入ASP.NET3.5控件和组件开发技术一般在基于Web的系统中用得最多，扩展灵活性也很强。CompositeControl此类为ASP.NET2.0版本时已经支持的一个控件基类。如果把现有控件聚合起来创建一个组合控件时，可以继承此类，此类默认实现了INamingContainer接口，并且对设计模式表现有较好的支持。后面会详细介绍其创建方法。一般用于将具有一定功能的多个控件集成为一个控件的情况。继承现有控件把具有一定功能的成型控件，如Label，Button，甚至GridView等控件，作为新控件的基类，并在此基础上扩展或改变（通过override重载其方法实现）其功能，满足业务需要。一般情况下开发一个基于Web平台的控件，比较常用的方法是从WebControl继承；本章主要讲开发一个控件的过程。就以继承WebControl为例来展开讲解。只要是Web控件，不管是ASP.NET控件还是第三方厂商控件，最终被解析到客户端的都是标准的HTML标记。也可以这么说，做一个控件的过程就是根据控件使用者设置控件的属性（简单值或复杂数据源集合等）进行组织HTML并输出的过程。控件无非就是把一些常用的功能抽象成一个通用的控件，提高重用性，节省开发时间，这样要比之前开发人员对每个页面用纯HTML开发要好多了。控件开发可以理解为组织HTML的过程。当然ASP.NET控件开发技术提供了一些规则，用多种方式有效地组织输出这些HTML标记，对样式、资源文件封装等也提供了一些帮助类和功能支持，下面我们就一起来看一下组织HTML标记的方式。3.2控件呈现顺序控件生命周期的Render阶段，主要将控件标记和字符文本输出到服务器控件输出流中。在这个阶段可以直接写HTML标记，也可以调用每个控件都有的RenderControl方法到输出流。在WebControl基类中，以Render开头的呈现方法有如下几个：RenderControl(HtmlTextWriterwriter)Render(HtmlTextWriterwriter)RenderBeginTag(HtmlTextWriterwriter)RenderContents(HtmlTextWriteroutput)RenderEndTag(HtmlTextWriterwriter)以上几个Render方法并不是毫无联系的，它们的执行顺序是从上往下，并且有嵌套的调用关系。其中在RenderControl方法内部会调用Render方法，在Render方法内部会依次调用RenderBeginTag,RenderContents和RenderEndTag。其中RenderControl和Render是Control基类中的方法，因为WebControl本身也是继承Control的。一般在开发基本控件时，我们只需重写RenderContents方法即可，在此方法中可以把控件HTML文本标记和其他内容写到输出流中。另外，还有两个可以重载的方法RenderBeginTag和RenderEndTag。这两个方法执行时刻点是分别在Render控件内容之前和之后。可以重写这两个方法自己定义控件的起始和结束标记。默认情况下控件是以Span/Span作为起始和结束标记的，图3-1是没有重写标记的一29第3章从零开始开发服务器控件个控件的默认显示。30庖丁解牛——纵向切入ASP.NET3.5控件和组件开发技术图3-1控件默认标记是Span/Span下面以一个例子来演示使用上面几个Render方法。新建一个RenderOrderControl.csWeb控件类，重载以下几个方法，并填充相应语句。代码如下所示：///summary///获得本书更多内容,请看:///方法执行顺序:3////summarypublicoverridevoidRenderBeginTag(HtmlTextWriterwriter){//base.RenderBeginTag(writer);writer.AddAttribute(HtmlTextWriterAttribute.Id,this.ID);writer.RenderBeginTag(HtmlTextWriterTag.Div);}///summary///Render方法执行顺序:4////summaryprotectedoverridevoidRenderContents(HtmlTextWriteroutput){output.Write(Text);}///summary///Render方法执行顺序:5////summarypublicoverridevoidRenderEndTag(HtmlTextWriterwriter){//base.RenderEndTag(writer);writer.RenderEndTag();}上面代码仅呈现出控件Text属性文本。另外，重写了控件起始和结尾标签。呈现到浏览器中的控件如图3-2所示。图3-2控件重写标记为div/div另外，读者可能注意到在RenderBeginTag和RenderEndTag方法中有：31第3章从零开始开发服务器控件base.RenderEngTag(writer);这里跟面向对象继承是一个概念，表示调用基类中的方法，当继承于某个控件，扩展功能时常用到这样的方法。有以下几种处理方式：（1）复制基类方法功能：直接调用base.Method()方式，不加任何代码。（2）扩展基类方式功能：除了调用base.Method()之外，增加自己的扩展功能代码，并且base.Method()在方法体中的位置可以根据需要任意放置。（3）替换基类方法功能：不调用base.Method()，并增加自己需要的新功能代码。（4）取消重载规则：使用new关键字代替override，这样仅保证方法名是相同的，其内部执行逻辑可以由自己任意组织，用于面向对象编程中实现与基类中毫无相关的功能。（5）禁用基类方法功能：保留一个空的方法体。说明：在本书讲解过程中的每一个例子都会有完整示例代码，对应于本书配套光盘的相关章节。3.3Render呈现控件的几种方式3.3.1使用HtmlTextWriter类输出先看一个例子，其功能是输出一个超链接控件：///summary///获得本书更多内容,请看:///(HtmlTextWriteroutput){//方式output.AddAttribute(HtmlTextWriterAttribute.Href,);output.AddAttribute(HtmlTextWriterAttribute.Target,blank);output.AddStyleAttribute(HtmlTextWriterStyle.Color,Blue);output.AddStyleAttribute(HtmlTextWriterStyle.Cursor,Hand);output.RenderBeginTag(HtmlTextWriterTag.A);output.Write(this.Text);output.RenderEndTag();output.WriteBreak();}RenderContents方法的参数类型为HtmlTextWriter，是具有呈现标记和其他HTML标记（包括HTML变量）的方法的实用工具类。该类能将控件的字符和文本标记等写入到服务器控件输出流中。并且此类在运行期间会自动生成实例。Output.AddAttribute方法生成控件的属性，它有许多重载方法，可以直接以字符串形式把属性名称和属性值写入到输出流，也可以使用HtmlTextWriterAttribute枚举，帮助输入控件属性，如下都是使用AddAttribute方法的一些例子：///summary///获得本书更多内容,请看:///庖丁解牛——纵向切入ASP.NET3.5控件和组件开发技术output.AddAttribute(HtmlTextWriterAttribute.Accesskey,n);output.AddAttribute(Accesskey,n);output.AddAttribute(HtmlTextWriterAttribute.Bgcolor,#6699ff);output.AddAttribute(bgcolor,#6699ff);output.AddAttribute(HtmlTextWriterAttribute.Checked,true);output.AddAttribute(checked,true);output.AddAttribute(HtmlTextWriterAttribute.Class,TextBoxStyleName);output.AddAttribute(class,TextBoxStyleName);output.AddAttribute(HtmlTextWriterAttribute.Onclick,alert('Hello'););output.AddAttribute(onclick,alert('Hello'););output.AddAttribute(HtmlTextWriterAttribute.ReadOnly,true);output.AddAttribute(readonly,true);output.AddAttribute(HtmlTextWriterAttribute.Tabindex,5);output.AddAttribute(tabindex,5);不用多说，仅通过这些例子读者就能够理解AddAttribute方法和Ht