ASP.NET组件设计Step by Step(8)

 

控制控件的样式

 

控件最终通常要生成HTML代码在客户端，这些HTML元素可以采用丰富的CSS样式。你当然可以直接进行CSS 设定，但是asp.net给控件开发者提供了编程方式控制样式的途径。

如果对样式无特殊要求，直接继承webControl的样式功能即可，如果需要修改或者扩充继承的样式功能，则需要深入了解控件样式的背景知识

WebControl的样式功能全部封装在ControlStyle属性中(一个名为Style System.Web.UI.WebControls.Style的属性)。所有样式属性都是ControlStyle属性的子属性。WebControl的ControlStyle的定义为：

Private Style _contentStyle;

……

public Style ControlStyle

{

       get

              {

                     if(_contentStyle = = null)

                            {

                                   _contentStyle=CreateControlStyle();

                                   if(IsTrackingViewState)

                                          {

                                                 ((IStateManager)_controlStyle).TrackViewState();

}

                            }

                     return  _contentStyle;

              }

}

我们看到，ControlStyle是只读属性，在第一次访问时被创建（这个思想继承了.net的JIT方案）。

那么这个CreateControlStyle到底是什么回事？

Protected virtual Style CreateControlStyle()

{

       return new Style(ViewSatte);

}

原来也是读取ViewState得到的。这样，无论是你从.aspx页面中关于控件声明中定义的还是通过编程设定的都可以在存取时反映得到。

作为控件开发者，可以自定义继承自Style的属性，例如，MyTable控件定义一个TableControl类型，添加Table支持的cellpadding/CellSpaceing等属性。

编程控制属性有3种途径：

1、  覆盖受保护的虚函数CreateControlStyle

2、  利用ApplyStyle（Style s）方法将自定义的属性复制到控件自己的ControlStyle中去

3、  MergeStyle(Style s)合并方法到ControlStyle中去

 

我们看到，控件的ControlStyle属性和其他子属性都是公用一个StateBag的。因为控件style生成时候是调用传递ViewState的构造函数。另外，子控件也是采用同一个StateeBag来存储状态的。

 

 

复合控件

首先明确复合控件不同于用户控件，因为它是编译后的形式出现的，而用户控件则以文本形式部署。但共同点都是类复用来复用他们的功能。

复合控件包含多个已存控件，复用子控件提供的功能。譬如，当要编写的复合控件包含TextBox时候，就不必自己实现IPostBackDataHandler接口。复合控件可以派生子Control类或者WebControl类，复合的要点是：

1、  重载CreateChildControl方法来对子控件进行实例化、初始化，并将子控件添加到控件树中（加入到page的控件树从而获得控件的生命周期）。需要避免的是不可在OnInit事件中执行业务逻辑。

2、  实现System..Web.UI.InamingContainer接口，从而在复合控件下建立一个新的命名范围。InamingContainer仅仅是一个标记接口，让框架自动实现子控件的唯一命名。

为什么必须在CreateChildControls方法中创建子控件呢？实际上，这样做是为了可以在控件生命周期中任何需要的时候来创建子控件，而且可以利用子控件来处理诸如会传数据等任务。为了确保子控件在代码访问其之前创建好,Controllei定义的EnsureChildControls保护方法来检查子控件是够已经创建好，如果没有创建，，就可以调用CreateChildControls方法来创建。如果子控件没有在render之前被创建，那么缺省情况下visible为true的未被创建的子控件会被PreRender方法的默认实现调用EnsureChildControls。

 

复合可以重用，但是也会带来性能损失（例如子控件实例化等）。所以，需要在性能和易用之间权衡，要么复合控件，要么干脆自己编写完全生成控件。

 

复合控件视图状态如何工作？

Control内建了跟踪、保存和恢复子控件的状态。

在开始跟踪视图状态阶段中，Control依次调用Controls集合中的控件的TrackVierState方法，跟踪子控件的状态。如果子控件是在父控件中打开状态下加入到Controls中，那么在添加到集合时候调用TrackViewState方法。

在保存视图状态阶段，Control首先调用SaveViewSate方法，默认情况下首先调用ViewState字典的SaveViewState。并保存所返回的对象，作为控件视图的第一部分；接下来，Control调用每一个子控件的SaveViewState，如果返回的子控件不为空，那么由Control在两个ArrayList中保存子控件的编号和对应状态，用来进行串行化。

在加载视图状态阶段，control先调用LoadViewState方法恢复上一次保存的状态第一部分，接下来Control访问Controls集合，将剩下的状态加载入子控件，一般通过编号和保存状态的ArrayList来组成，这样就恢复了控件及其子控件的转台。如果在此阶段还没有创建子控件，那么先保存子控件状态，留做以后使用，直到子控件创建后加载给子控件。

 

事件冒泡

ASP.NET 页框架提供一种称为“事件冒泡”的技术，允许子控件将事件沿其包容层次结构向上传播。事件冒泡允许在控件层次结构中更方便的位置引发事件，并且允许将事件处理程序附加到原始控件以及公开冒泡的事件的控件上。

例如：数据绑定控件（Repeater、DataList 和 DataGrid）使用事件冒泡将子控件（在项目模板内）引发的命令事件公开为顶级事件。虽然 .NET 框架中的 ASP.NET 服务器控件将事件冒泡用于命令事件（事件数据类是从 CommandEventArgs 派生的事件），但是，服务器控件上定义的任何事件都可以冒泡。

控件可以通过从基类 System.Web.UI.Control 继承的两个方法参与事件冒泡。这两个方法是：OnBubbleEvent 和 RaiseBubbleEvent。以下代码片段显示了这些方法的签名。

protected virtual bool OnBubbleEvent(

   object source,

   EventArgs args

);

protected void RaiseBubbleEvent(

   object source,

   EventArgs args

);

RaiseBubbleEvent 的实现是由 Control 提供的，并且不能被重写。RaiseBubbleEvent 沿层次结构向上将事件数据发送到控件的父级。若要处理或引发冒泡的事件，控件必须重写 OnBubbleEvent 方法。

 

使事件冒泡的控件执行以下三种操作之一。

1、控件不执行任何操作，此时事件自动向上冒泡到其父级。

2、控件进行一些处理并继续使事件冒泡。若要实现这一点，控件必须重写 OnBubbleEvent，并从 OnBubbleEvent 调用 RaiseBubbleEvent。以下代码片段（摘自模板化数据绑定控件示例）在检查事件参数的类型后使事件冒泡。

protected override bool OnBubbleEvent(object source, EventArgs e) {

            if (e  is CommandEventArgs) {               

                TemplatedListCommandEventArgs args =

                    new TemplatedListCommandEventArgs(this, source, (CommandEventArgs)e);

                RaiseBubbleEvent(this, args);

                return true;

            }

            return false;

        }

3、控件停止事件冒泡并引发和/或处理该事件。引发事件需要调用将事件调度给侦听器的方法。若要引发冒泡的事件，控件必须重写 OnBubbleEvent 以调用引发此冒泡的事件的 OnEventName 方法。引发冒泡的事件的控件通常将冒泡的事件公开为顶级事件。

protected override bool OnBubbleEvent(object source, EventArgs e) {

    bool handled = false;

    if (e is TemplatedListCommandEventArgs) {

        TemplatedListCommandEventArgs ce = (TemplatedListCommandEventArgs)e;

        OnItemCommand(ce);

        handled = true;

    }

    return handled;

}

 

模板化控件

使用模版化控件，控件开发者可以通过template指定生成的全部或者部分UI。模板是页面语法的一部分，可以包括静态的HTML(HTML语法表达的控件实际上是子控件，但是属于LiteralControl控件)以及其他文自文本的服务器控件。模板功能，允许将控制数据与其表示分开。模板控件本身不提供用户界面 (UI)。该控件的 UI 由页面开发人员通过内联模板提供,该模板允许页面开发人员自定义该控件的 UI。通过使用模板，控件生成不同于样式的UI，但是这种UI能力主要是产生页面元素。譬如repeater控件等。

要支持模板化，控件必须实现Itemplate接口。页面解析器解析模板标签内的文本，并生成一个解析树来表示模板的内容，就像解析整个Page一样。支持模板控件开发需要做到：

1、实现 System.Web.UI.INamingContainer 接口。这是没有任何方法的标记接口。它可以在您的控件下创建新的命名范围，这样子控件就在名称树中有了唯一的标识符。

public class TemplatedFirstControl : Control,INamingContainer {...}

2、将 ParseChildrenAttribute 应用到控件，并传递 true 作为参数。在 ASP.NET 页上声明性地使用控件时，这样可指示页分析器如何分析模板属性标记。步骤 3 说明如何定义一个模板属性。 注意 如果您的控件是从 WebControl 派生的，则不需要应用 ParseChildrenAttribute，因为 WebControl 已经用该属性作了标记。

[ ParseChildren(ChildrenAsProperties = true)]

public class TemplatedFirstControl : Control, INamingContainer {...}

3、定义 System.Web.UI.ITemplate 类型的一个或多个属性。ITemplate 有一个方法 InstantiateIn，该方法可使用页上内联提供的模板创建控件。不必实现 InstantiateIn 方法；ASP.NET 页框架可提供这种实现。ITemplate 属性必须有 System.Web.UI.TemplateContainerAttribute 类型的元数据属性，它指出哪种 INamingContainer 控件将拥有实例化模板。这在步骤 4 中作了说明。如下代码所示定义了一个模板属性。

[TemplateContainer(typeof(FirstTemplateContainer))]                 

 public ITemplate FirstTemplate {...}

4、TemplateContainerAttribute 的参数是您想在其中实例化模板的容器控件类型。容器控件独立于正在创作的模板控件。具有逻辑容器的原因是：模板控件通常有一个模板，该模板需要使用不同数据重复实例化。拥有与根模板控件不同的容器控件，使拥有多个此类示例成为可能。逻辑容器是该模板内子控件的即时 INamingContainer。在开发模板化数据绑定控件中更详细地介绍了这种关系。

注意 容器控件本身必须实现 INamingContainer，因为它有需要在页上唯一命名的子控件。但是容器仅仅是容器，对应需要解释的模板内容，并非控件。

public class FirstTemplateContainer : Control, INamingContainer {...}

5、重写 CreateChildControls 方法以便在模板中创建子控件。这是通过三个步骤来完成的。

实例化模板容器。

调用模板属性的 InstantiateIn 方法并将该容器作为参数传递给它。InstantiateIn 方法（在 ITemplate 接口中声明）实例化该模板的元素，作为该模板容器的子控件。不必实现 InstantiateIn 方法；ASP.NET 页框架可提供这种实现。

将模板容器的示例添加到您的模板控件的 Controls 集合。

以下代码片段说明了 CreateChildControls 的实现。

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));

    }

 }

5、重写从 Control 继承的 OnDataBinding 方法以调用 EnsureChildControls 方法。这样可保证在页框架尝试计算模板内任何数据绑定表达式之前，创建模板中的子控件。您还必须调用基类的 OnDataBinding 方法以确保调用已注册的事件处理程序。

        protected override void OnDataBinding(EventArgs e) {

            EnsureChildControls();

            base.OnDataBinding(e);

        }

7、在步骤 5 中，在 CreateChildControls 方法内重复该逻辑，以便为控件的每个模板属性实例化一个模板。

我们看到，通常情况下我们在模板内指定的Container实际上需要我们控件开发者自行定义。实际上如果不重复生成子控件，InamingContainer也可不实现。但是开始提醒需要实现此接口。如果要在控件中支持数据绑定，那么模板容器应该由一个或者多个属性代表绑定的数据。通常模板类作为控件类的内部私有类实现。

控件可以重复实例化某个模板（只要在不同的容器实例中即可），因此，模板不应该包含或者假定任何控件实例作为成员变量，因为在每次模板实例化时候，成员变量都可以用新的值来重写。