获取GridView/UserControl生成的Html代码

      在很多时候，我们需要直接获取到GridView等服务器控件生成的HTML代码，例如导出Excel，或者使用Ajax进行局部刷新时。

      假若你使用Ajax Pro要局部更新一个GridView，可以尝试直接返回GridView生成的Html代码。

      Asp.net的服务器控件，都有一个RenderControl方法，使用控件的这个方法，我们可以很方便的得到该控件生成的Html代码，但现实和想角往往是有差距的。在我得到GridView的过程中遇到了两个问题。

 

得到GridView生成的Html Code：

1.   /// <summary>
2.     /// 用来做例子中的数据源
3.     /// </summary>
4.     /// <returns></returns>
5.     private DataTable BuildGridViewDataSource()
6.     {
7.         DataTable dt = new DataTable();
8.         dt.Columns.Add("Number");
10.         DataRow dr = dt.NewRow();
11.         dr["Number"] = "1000";
12.         dt.Rows.Add(dr);
14.         dr = dt.NewRow();
15.         dr["Number"] = "1001";
16.         dt.Rows.Add(dr);
18.         return dt;
19.     }
21.     public void BindGridView()
22.     {
23.         GridView1.DataSource = BuildGridViewDataSource();
24.         GridView1.DataBind();
25.     }

 

1.   BindGridView();
2.         StringWriter tw = new StringWriter();
3.         HtmlTextWriter writer = new HtmlTextWriter(tw);
4.         GridView1.RenderControl(writer);
5.         DIV_Test.InnerHtml = writer.InnerWriter.ToString();     //writer.InnerWriter即是我们需要的GridView Html代码

问题1：类型“GridView”的控件“GridView1”必须放在具有 runat=server 的窗体标记内。

解决了问题1后，又遇到了

问题2：只能在执行 Render() 的过程中调用 RegisterForEventValidation

 

第一个问题通过查询MSDN文档库，发现如下描述：

如果控件未在移动 Web 窗体中以 DesignMode 呈现，则此方法将重写 Page.VerifyRenderingInServerForm 方法以引发异常。

必须位于 <form runat=server> 标记中的控件可以在呈现之前调用此方法，以便在控件被置于标记外时显示错误信息。发送回或依赖于注册的脚本块的控件应该在 Control.Render 方法的重写中调用此方法。呈现服务器窗体元素的方式不同的页可以重写此方法以在不同的条件下引发异常。

如果回发或使用客户端脚本的服务器控件没有包含在 HtmlForm 服务器控件 (<form runat="server">) 标记中，它们将无法正常工作。这些控件可以在呈现时调用该方法，以在它们没有包含在 HtmlForm 控件中时提供明确的错误信息。

开发自定义服务器控件时，通常在为任何类型的输入标记重写 Render 方法时调用该方法。这在输入控件调用 GetPostBackEventReference 或发出客户端脚本时尤其重要。复合服务器控件不需要作出此调用。

 

简单来说，这个方法就是验证控件是否是在<form runat="server">标记中，注意上面加粗的文字，那么我们找到了解决办法，最简直就是复写VerifyRenderingInServerForm这个方法，让他不验证，这关就过了，为了不影响其实应用，所以我们可以对Control的Type进行验证，只有当Control是GridView或者其它会引发这个异常的Control，我们跳过验证。

1.  public override void VerifyRenderingInServerForm(Control control)
2.     {
3.         //如果control是GridView，跳过验证，这里最好的验证是验证control的Id
4.         if (control is GridView || control is RadioButton)
5.         {
6.             return;
7.         }
8.         base.VerifyRenderingInServerForm(control);
9.     }

问题2的解决办法，在MSDN库中查到RegisterForEventValidation的作用为验证注册事件引用。 在Page的Html页首加入EnableEventValidation="false",跳过这个验证，这样问题2解决。

1. <%@ Page Language="C#" AutoEventWireup="true" EnableEventValidation="true" CodeFile="TestRenderControl.aspx.cs" Inherits="TestRenderControl" %>

下面提供一个得到UserControl 的Html代码的完整例子，它和得到GridView的Html代码是一样的。

 

UserControl Code：

 

ASCX

1. <%@ Control Language="C#" AutoEventWireup="true" CodeFile="WebUserControl.ascx.cs" Inherits="WebUserControl" %>
2.  <asp:GridView ID="GridView1" runat="server">
3.                 <Columns>
4.                     <asp:TemplateField HeaderText="操作">
5.                         <HeaderTemplate>
6.                              
7.                         </HeaderTemplate>
8.                         <ItemTemplate>
9.                             <asp:RadioButton ID="RadioButton1" runat="server" Text="选择" />
10.                         </ItemTemplate>
11.                     </asp:TemplateField>
12.                 </Columns>
13.             </asp:GridView>
14.             <br />
15. <asp:TextBox ID="TextBox1" runat="server">aaaaa</asp:TextBox> 
16. <asp:ImageButton ID="ImageButton1" runat="server" />
17. <asp:DropDownList ID="DropDownList1" runat="server">
18.     <asp:ListItem>sdfsdfsdf</asp:ListItem>
19.     <asp:ListItem>dfgfdgfdg</asp:ListItem>
20.     <asp:ListItem></asp:ListItem>
21. </asp:DropDownList>

CS Code

1. using System.Data;
2. using System.Configuration;
3. using System.Collections;
4. using System.Web;
5. using System.Web.Security;
6. using System.Web.UI;
7. using System.Web.UI.WebControls;
8. using System.Web.UI.WebControls.WebParts;
9. using System.Web.UI.HtmlControls;
11. public partial class WebUserControl : System.Web.UI.UserControl
12. {
13.     protected void Page_Load(object sender, EventArgs e)
14.     {
16.     }
18.     /// <summary>
19.     /// 用来做例子中的数据源
20.     /// </summary>
21.     /// <returns></returns>
22.     private DataTable BuildGridViewDataSource()
23.     {
24.         DataTable dt = new DataTable();
25.         dt.Columns.Add("Number");
27.         DataRow dr = dt.NewRow();
28.         dr["Number"] = "1000";
29.         dt.Rows.Add(dr);
31.         dr = dt.NewRow();
32.         dr["Number"] = "1001";
33.         dt.Rows.Add(dr);
35.         return dt;
36.     }
38.     public void BindGridView()
39.     {
40.         GridView1.DataSource = BuildGridViewDataSource();
41.         GridView1.DataBind();
42.     }
44. }

Test Page Html Code

1. <%@ Page Language="C#" AutoEventWireup="true" EnableEventValidation="false" CodeFile="TestRenderControl.aspx.cs" Inherits="TestRenderControl" %>
3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5. <html xmlns="http://www.w3.org/1999/xhtml" >
6. <head runat="server">
7.     <title>无标题页</title>
8. </head>
9. <body>
10.     <form id="form1" runat="server">
11.     <div runat="server" id="DIV_Test" style="width:100%; text-align:center;"></div>
12.     
13.     <asp:Button ID="Submit" runat="server" Text="提交" OnClick="Submit_Click" />
14.     </form>
15. </body>
16. </html>

Test Page Cs Code

1. using System;
2. using System.Data;
3. using System.Configuration;
4. using System.Collections;
5. using System.Web;
6. using System.Web.Security;
7. using System.Web.UI;
8. using System.Web.UI.WebControls;
9. using System.Web.UI.WebControls.WebParts;
10. using System.Web.UI.HtmlControls;
11. using System.IO;
13. public partial class TestRenderControl : System.Web.UI.Page
14. {
15.     protected void Page_Load(object sender, EventArgs e)
16.     {       
17.     }
18.     public override void VerifyRenderingInServerForm(Control control)
19.     {
20.         //如果control是GridView，跳过验证，这里最好的验证是验证control的Id
21.         //if (control is GridView || control is RadioButton)
22.         //{
23.         //    return;
24.         //}
25.         //base.VerifyRenderingInServerForm(control);
26.     }
28.     protected void Submit_Click(object sender, EventArgs e)
29.     {
30.         WebUserControl control = LoadControl("WebUserControl.ascx") as WebUserControl;
31.         control.BindGridView();
32.         StringWriter tw = new StringWriter();
33.         HtmlTextWriter writer = new HtmlTextWriter(tw);
34.         control.RenderControl(writer);
35.         DIV_Test.InnerHtml = writer.InnerWriter.ToString();
36.     }
37. }