在Asp.Net中动态加载控件

在Asp.Net中动态加载控件

原文:http://bhaidar.net/cs/pages/load-controls-dynamically-in-asp-net.aspx
作者:BilalHaidar [MVP]

发表于:2008-7-27 1:44 AM

译者:兴百放

摘要:
     在本文中,我将向您演示在Asp.Net页面中动态加载控件的一种方法。
问题:
     假设您有一个Aspx页面,其包含一个名为"Add New"的Button,而您则想让用户每次点击Button,PostBack到Server,然后创建一个用户控件的实列,并最终想动态的添加到该页面的ControlCollections中。
     之所以我说用用户控件,是因为我们很容易把许多的控件组织到一个单独的控件中,添加的时候,我们只需把该用户控件添加到页面上就可以了。

设计解决方法:
     我所想到的解决该问题的方法是在Aspx页面上放一个PlaceHolder容器控件,该控件可以把所有的控件动态的添加到里面。另外,我们还设计一种"Page Controller"模式,让所有操作动态添加控件的方法都放到一个名为BasePage基类中,也就意味着,如果我们的一些Aspx页面想动态的添加一些控件,我们只需从这个BasePage类继承。
     最后,我们也必须考虑在一个Aspx页面上不仅仅包含一个PlaceHolder,反之,您可以把控件动态的添加到任何的地方

最终解决方法

     首先在Vs 2008创建一个WebSite.

     创建完之后,添加一个BasePage类,然后把下面的代码添加到其中

Code
     该SESSION_CONTAINERS_KEY将被用做Session 的值来保存,而PATH_TO_CONTROL则定义了您的程序所要载入用户控件的虚拟路径。
     现在在添加数据字典属性
Code

     如果您读上面属性的注释,您很容易就明白这段方法的作用。它仅仅只是把添加到页面上所有用户控件的每一个PlaceHolder放到一个字典中,页面上所有的PlaceHoder都有一个数据字典,并且每一个PlaceHolder都有一个用户控件集合的数据字典。

     在BasePage中我们还得需要一个创建用户控件实列的方法,我们命名为CreateControlInstance,以下是其实现:

Code

     这个方法很简单,我们只是把传过来的controlName,controlKey进行格式转换。对于controlName,我们把*~/App_Controls/{0}*其中的{0}参数, 替换成想 *~/App_Controls/MyControl.ascx"的形式,而把该Control的ID,用Guid值替换掉*MyControl_{0}*中的{0}参数。

     另一个重要的方法是 *AddControlToContainer*. 其实现如下:

Code

     这个方法非常重要,它接受两个参数,一个是您所添加的用户控件,一个是您想把该用户控件添加到传过来的指定的PlaceHolder.首先该方法会检查在Containers容器的列表中,连同添加到其中的Controls是否保存在Sesssion变量中,在这里您是否还记得我在上面提到的SESSION_CONTAINERS_KEY常量,它就是用作Session变量的retreival key。
     如果这个Session变量为空,也就意味着用户是首次添加一个用户控件,之后则创建一个Container的实列。
     该代码也检查在该Container容器中是否包含以PlaceHoler的ClientID为名称的字典,如果没有则说明用户控件是首次添加到指定的PlaceHolder控件中,为此,则添加一个新的空的的记录来保存将来要添加到该PlaceHolder中的UserControl或UserControls。
     随后在检查在该指定的PlaceHolder中是否包含以用户控件的ClientID为健的控件,如果没有,则添加到其PlaceHolder中。
     最后。Session[SESSION_CONTAINERS_KEY]被新的或者以更新的container所更新。

     最后一个重要的方法是 *LoadExistingControls* ,它负责把所有的用户控件添加到Aspx页面中

Code

     该方法接收一个PlaceHolder作为其参数,并首先验证并确认在Container中是否包含相应的PlaceHolder,如果有,则循环所有指定Container中的所有记录,并把每一个用户控件添加到接收的PlaceHolder中。之后将会自动呈现在Aspx页面中。

     这就是动态添加控件基本主要的方法和属性的一种解决方案。

列子

     对于该列子,我添加了一个名为 *MyControl.ascx*用户控件,并把其放在站点的*~/App_Controls/* 文件夹下。该用户控件非常简单,仅仅包含输入姓名的两个文本框。
     而Aspx页面,则从我们刚才的BasePage类继承来替代标准的Page类,它也提供了我们额外的一些辅助方法。

     在Aspx中,包含一些的Button和我们想要动态添加控件容器的PlaceHolder。下面是首次运行的截图

     在Aspx页面的.cs文件中还有一些非常重要的事要做

     首先,您应该在页面请求或者PostBack的时候,确保所有的Control是否添加到页面的ControlCollection中。
     而在Aspx页面中要实现该方法,最好的时机就是在页面欲呈现的时候。代码:

Code

     它就会调用BasePage中的 *LoadExistingControls* 方法,并把您所要动态添加控件的PlaceHolder作为参数传进去,确保所有的控件都载入到页面中。

     当您想要添加一个新的用户控件,您只需点击一下名为 *Add New* 的Button 下面是该Button的代码

Code

     该Button首先调用了BasePage中的*CreateControlInstance* 来创建了一个新的用户控件的实列,一旦该实例创建,他就会把该实列和该实列的容器(phContainer)传递到BasePage中的*AddControlToContainer*方法,最后,我们在重新载入开始我们已经添加到该PlaceHolder中的控件。


     为了使该实列更有说服力,我添加了一个名为*IMyControl.cs*接口类:代码如下

Code

     在其中,我们仅仅定义了一个方法,但是它却能对您的程序起到重要的作用。

     我使所有的用户控件都继承这个接口,并实现它。

     那好,现在当您点击页面上的*Save Data*按钮,它将会循环加载指定Container中的Controls,并调用继承自IMyControl接口的User Control的Save 方法. 代码如下:

Code

     正如你所看到的,我们使用Container属性访问我们指定的Place Holder,一旦访问成功,就开始循环其中的所有的UserControls,而后调用其中每一个实现IMyControl接口的Save 方法,您也可以实现您所需要的功能。

     当您点击*Save Data* 按钮,您就会看到如下的截图2,它只是把添加到页面上的UserControl的基本信息输出到页面上。

     这个Aspx页面也演示了怎样处理不仅仅只有一个placeHolder也可能有2个或多个PlaceHolder,你可以按你需要任意添加多个。

总结

     在本文中,我只是介绍了动态向Aspx页面添加控件的一种方法。您可以跟随着本文的代码和说明进行阅读,或者下载本文中代码的源代码。

      希望您喜欢这篇文章!

      Regards

源代码下载
注:如果有翻译的不准确的地方,还望各位看官多多指教,我会尽快修改
posted on 2008-08-01 23:35  草原和大树  阅读(1713)  评论(0编辑  收藏  举报