ASP.NET AJAX RC Tip：页面中无UpdatePanel时UpdateProgress创建出错问题

昨日下午，IM上遇到菌哥，被问到为什么安装ASP.NET AJAX RC之后，某些页面总是在创建UpdateProgress时出现脚本错误。当时给了一个不太好的解决方案，刚才简单看了一下System.Web.Extensions.dll中的相关实现，得出了一个更好的解决方案，在这里简单地说一下。

首先，我模拟一个“事发现场”，由此开始解决问题：一般来说，在所有的页面中可能需要统一的Updating Animation，于是可能会将一个UpdateProgress连同ScriptManager放在MasterPage中，如下：

<asp:ScriptManager ID="ScriptManager1" runat="server" ScriptMode="Debug">
</asp:ScriptManager>

<asp:ContentPlaceHolder id="Main" runat="server"></asp:ContentPlaceHolder>

<asp:UpdateProgress ID="UpdateProgress1" runat="server">
    <ProgressTemplate>
        Hello World!
    </ProgressTemplate>
</asp:UpdateProgress>

 

如果直接以此生成一个页面，并随意加上一个UpdatePanel：

<asp:Content ID="Content1" ContentPlaceHolderID="Main" Runat="Server">

    <asp:UpdatePanel runat="server">
        <ContentTemplate>
            ...
        </ContentTemplate>
    </asp:UpdatePanel>

</asp:Content>

 

此时生成的HTML为：

...
<form>
...
    <script src="/AjaxEnabledWebSite/WebResource.axd?..."
 type="text/javascript"></script>

    <!-- MicrosoftAjax.js -->
    <script src="/AjaxEnabledWebSite/ScriptResource.axd?..."
 type="text/javascript"></script>

    <!-- MicrosoftAjaxWebForms.js -->
    <script src="/AjaxEnabledWebSite/ScriptResource.axd?..."
 type="text/javascript"></script>

...
    <script type="text/javascript">
        <!--
        Sys.Application.initialize();
        Sys.Application.add_init(function() {
            $create(
  Sys.UI._UpdateProgress,
  {"associatedUpdatePanelId":null,
   "displayAfter":500,
   "dynamicLayout":true},
   null,
   null,
   $get("ctl00_UpdateProgress1"));
        });
        // -->
    </script>
...
</form>
...

 

请注意此时的UpdateProgress以一个Sys.UI.Control的形式使用$create被创建，而Sys.UI._UpdateProgress（看来ASP.NET AJAX不希望我们直接使用这个类）是在MicrosoftAjaxWebForms.js文件里被引入。

于是问题就出现了，如果页面中没有UpdatePanel，那么MicrosoftAjaxWebForms.js文件不会被引入，而那句$create还在！这就导致了JavaScript错误的发生。当时我提供的方法是：那么就在Site.master里强制加上一个UpdatePanel吧。如下：

<asp:UpdatePanel runat="server" UpdateMode="Conditional" ID="UP1">
    <ContentTemplate></ContentTemplate>
</asp:UpdatePanel>

 

这里把UpdateMode设为了Conditional，也就是说，这里的UpdatePanel永远不会被更新，它的作用只是“强迫”MicrosoftAjaxWebForms.js文件被引入。不过这不是个好的解决方案。

如果要解决这个问题，不要让$create语句出现不就可以了吗？在查看过代码以后，发现$create语句只会在ScriptManager的EnablePartialRendering属性为True的情况下出现，那么我们就把ScriptManager的这个属性暴露出去吧。我们可以修改一下Site.master.cs中Site类的代码，把它增加一个属性：

public bool EnablePartialRendering
{
    get
    {
        return this.ScriptManager1.EnablePartialRendering;
    }
    set
    {
        this.ScriptManager1.EnablePartialRendering = value;
    }
}

 

然后在页面里把MasterPage的EnablePartialRendering属性设为False即可。需要注意的是只有Init阶段才能设置ScriptManager的EnablePartialRendering属性。如下：

protected override void OnInit(EventArgs e)
{
    base.OnInit(e);

    (this.Master as Site).EnablePartialRendering = false;
}

 

至此，任务结束。