ASP.NET 4.5 ScriptManager Improvements in WebForms

The ScriptManger control has undergone some key targeted changes in ASP.NET 4.5 which makes it easier to register, manage and combine scripts using the ASP.NET weboptimization feature. This post will highlight the changes that have happened to this control

Easy Integration with JQuery and JQueryUI

The default templates for WebForms ship with the following packages “AspNet.ScriptManager.jQuery” and “AspNet.ScriptManager.jQuery.UI.Combined”. These packages make it easier to bring in jquery and jqueryUI libraries and also register them with the ScriptManager. Here is how it works.

These packages add the following ScriptMappings for jquery and jqueryUI in the PreApplicationStart method of the application

JQuery

string str = "1.7.1";

    ScriptManager.ScriptResourceMapping.AddDefinition("jquery", new ScriptResourceDefinition

        Path = "~/Scripts/jquery-" + str + ".min.js",

        DebugPath = "~/Scripts/jquery-" + str + ".js",

        CdnPath = "http://ajax.aspnetcdn.com/ajax/jQuery/jquery-" + str + ".min.js",

        CdnDebugPath = "http://ajax.aspnetcdn.com/ajax/jQuery/jquery-" + str + ".js",

        CdnSupportsSecureConnection = true,

        LoadSuccessExpression = "window.jQuery"

});

JQuery.UI

string str = "1.8.20";

    ScriptManager.ScriptResourceMapping.AddDefinition("jquery.ui.combined", new ScriptResourceDefinition

        Path = "~/Scripts/jquery-ui-" + str + ".min.js",

        DebugPath = "~/Scripts/jquery-ui-" + str + ".js",

        CdnPath = "http://ajax.aspnetcdn.com/ajax/jquery.ui/" + str + "/jquery-ui.min.js",

        CdnDebugPath = "http://ajax.aspnetcdn.com/ajax/jquery.ui/" + str + "/jquery-ui.js",

        CdnSupportsSecureConnection = true

});

These SciptMappings are registered with ScriptManager as follows

"server">

            "jquery" />

            "jquery.ui.combined" />

Now you can enjoy all the benefits of having ScriptManager such as

Debug/Release Support

If you are debugging your application(debug=true) in web.config then ScriptManager will serve the scripts from debug path(non minified scripts) such as “~/Scripts/jquery-1.7.1.js”

CDN Support

If your set EnableCDN=true on the ScriptManager control, then all the Scripts will be served from the CDN path such as “http://ajax.aspnetcdn.com/ajax/jquery-1.7.1.js”

Override Script Mappings

Let’s assume that you wanted to override the scriptmappings to change the CDN path where these scripts are served from. You can do so by changing the scriptmapping before the page is accessed. Typically doing this in Global.asax is better

string str = "1.7.1";

    ScriptManager.ScriptResourceMapping.AddDefinition("jquery", new ScriptResourceDefinition

        Path = "~/Scripts/jquery-" + str + ".min.js",

        DebugPath = "~/Scripts/jquery-" + str + ".js",

        CdnPath = "http://http://code.jquery.com/jquery-"+ str + ".min.js",

        CdnDebugPath = "http://code.jquery.com/jquery-"+ str + ".js",

        CdnSupportsSecureConnection = true

});

Updating Jquery/JqueryUI libraries

Let’s say a new version of Jquery or JqueryUI comes along. Traditionally you would have to download the jquery packages for these libraries and then update the script references everywhere on your pages. With the above integration of AspNet.ScriptManager.Jquery packges this scenario really becomes easy since when you update Jquery/JqueryUI you will get corresponding versions of AspNet.ScriptManager.Jquery/AspNet.ScriptManager.Jquery.UI which will update the scriptmappings to the current version of jquery that was downloaded and you do not have to change anything in your application

LoadSuccessExpression

This is a new property which is added to the ScriptMapping and it takes care of the following use case. Imagine that you are serving your scripts from a CDN path and if there is an outage in the CDN, your site will be affected because you will not be able to serve any scripts. This property takes in an expression which evaluates whether the script was loaded correctly and if it fails then it renders the script from the local application path.

Following is how the script tag looks like for jquery(assuming that you are serving scripts from CDN)

//

(window.jQuery)||document.write(');//]]>

Remapping Framework scripts

One neat improvement that happened in ASP.NET 4.5 is the decoupling of the “Microsoft Ajax script files(MicrosoftAjaxCore etc)” and the WebForms scripts(GridView.js etc). We did the work in this release so you can serve these scripts from your application Scripts folder rather than load then up from System.Web This makes the scripts easily redistributable and updateable. The following section explains on how you can use these scripts and combine them with WebOptimization feature

Serving Framework Scripts from inside the application

We created the following 2 packages “Microsoft.AspNet.ScriptManager.MSAjax” “Microsoft.AspNet.ScriptManager.WebForms” which do the following

Install the Scripts into your application so it looks like follows

These packages also create the following scriptmappings so that they can be registered with ScriptManager as follows

MicrosoftAjax scripts

We are registering all the scripts and we are bundling them together as “MsAjaxBundle”

ScriptManager.ScriptResourceMapping.AddDefinition("MsAjaxBundle", new ScriptResourceDefinition

        Path = "~/bundles/MsAjaxJs",

        CdnPath = "http://ajax.aspnetcdn.com/ajax/4.5/6/MsAjaxBundle.js",

        LoadSuccessExpression = "window.Sys",

        CdnSupportsSecureConnection = true

});

    PreApplicationStartCode.AddMsAjaxMapping("MicrosoftAjax.js", "window.Sys && Sys._Application && Sys.Observer");

    PreApplicationStartCode.AddMsAjaxMapping("MicrosoftAjaxCore.js", "window.Type && Sys.Observer");

    PreApplicationStartCode.AddMsAjaxMapping("MicrosoftAjaxGlobalization.js", "window.Sys && Sys.CultureInfo");

    PreApplicationStartCode.AddMsAjaxMapping("MicrosoftAjaxSerialization.js", "window.Sys && Sys.Serialization");

    PreApplicationStartCode.AddMsAjaxMapping("MicrosoftAjaxComponentModel.js", "window.Sys && Sys.CommandEventArgs");

    PreApplicationStartCode.AddMsAjaxMapping("MicrosoftAjaxNetwork.js", "window.Sys && Sys.Net && Sys.Net.WebRequestExecutor");

    PreApplicationStartCode.AddMsAjaxMapping("MicrosoftAjaxHistory.js", "window.Sys && Sys.HistoryEventArgs");

    PreApplicationStartCode.AddMsAjaxMapping("MicrosoftAjaxWebServices.js", "window.Sys && Sys.Net && Sys.Net.WebServiceProxy");

    PreApplicationStartCode.AddMsAjaxMapping("MicrosoftAjaxTimer.js", "window.Sys && Sys.UI && Sys.UI._Timer");

    PreApplicationStartCode.AddMsAjaxMapping("MicrosoftAjaxWebForms.js", "window.Sys && Sys.WebForms");

    PreApplicationStartCode.AddMsAjaxMapping("MicrosoftAjaxApplicationServices.js", "window.Sys && Sys.Services");

Here is the Bundle definition for these scripts

bundles.Add(new ScriptBundle("~/bundles/MsAjaxJs").Include(

                "~/Scripts/WebForms/MsAjax/MicrosoftAjax.js",

                "~/Scripts/WebForms/MsAjax/MicrosoftAjaxApplicationServices.js",

                "~/Scripts/WebForms/MsAjax/MicrosoftAjaxTimer.js",

                "~/Scripts/WebForms/MsAjax/MicrosoftAjaxWebForms.js"));

Here is the ScriptManger registration for these scripts

"server" >

            <%--Framework Scripts--%>

            "MsAjaxBundle" />

            <%--Site Scripts--%>

WebForms scripts

We are registering all the scripts and we are bundling them together as “WebFormsBundle”

ScriptManager.ScriptResourceMapping.AddDefinition("WebFormsBundle", new ScriptResourceDefinition

        Path = "~/bundles/WebFormsJs",

        CdnPath = "http://ajax.aspnetcdn.com/ajax/4.5/6/WebFormsBundle.js",

        LoadSuccessExpression = "window.WebForm_PostBackOptions",

        CdnSupportsSecureConnection = true

});

Bundle Definition

bundles.Add(new ScriptBundle("~/bundles/WebFormsJs").Include(

                  "~/Scripts/WebForms/WebForms.js",

                  "~/Scripts/WebForms/WebUIValidation.js",

                  "~/Scripts/WebForms/MenuStandards.js",

                  "~/Scripts/WebForms/Focus.js",

                  "~/Scripts/WebForms/GridView.js",

                  "~/Scripts/WebForms/DetailsView.js",

                  "~/Scripts/WebForms/TreeView.js",

                  "~/Scripts/WebForms/WebParts.js"));

ScriptManager registration

The reason we have the Assembly and the Path attribute here is because ScriptManager special cases these scripts when it tries to load them, so we had to make some special arrangements with ScriptManager code to make this work Smile This is a process which is called deduping. Basically when the ScriptManager tried to load up these scripts, it can load them up from System.Web or the path attribute and eventually in this case, the ScriptManager dedupes the script references and serves the scripts from the path attribute. This is part of the “special arrangement” that we did in ScriptManager. We were very cautious when doing this given this code path was on a very critical path for mainline ScriptManager scenarios which we did not want to regress.

"server" >

            <%--Framework Scripts--%>

            "WebForms.js" Assembly="System.Web" Path="~/Scripts/WebForms/WebForms.js" />

            "WebUIValidation.js" Assembly="System.Web" Path="~/Scripts/WebForms/WebUIValidation.js" />

            "MenuStandards.js" Assembly="System.Web" Path="~/Scripts/WebForms/MenuStandards.js" />

            "GridView.js" Assembly="System.Web" Path="~/Scripts/WebForms/GridView.js" />

            "DetailsView.js" Assembly="System.Web" Path="~/Scripts/WebForms/DetailsView.js" />

            "TreeView.js" Assembly="System.Web" Path="~/Scripts/WebForms/TreeView.js" />

            "WebParts.js" Assembly="System.Web" Path="~/Scripts/WebForms/WebParts.js" />

            "Focus.js" Assembly="System.Web" Path="~/Scripts/WebForms/Focus.js" />

            "WebFormsBundle" />

            <%--Site Scripts--%>

When you run this page you will get script references as follows

So these were the improvements that happened in the ScriptManager control for registering scripts. In case you want to refresh your memory, ScriptManager was greatly enhanced in ASP.NET v4.0 and Dave Reed had a fantastic post about it, which I strongly recommend to go through.

This is cross posted on http://blogs.msdn.com/b/pranav_rastogi/archive/2012/09/21/asp-net-4-5-scriptmanager-improvements-in-webforms.aspx

ASP.NET 4.5 ScriptManager Improvements in WebForms

Easy Integration with JQuery and JQueryUI

JQuery

JQuery.UI

Debug/Release Support

CDN Support

Override Script Mappings

Updating Jquery/JqueryUI libraries

LoadSuccessExpression

Remapping Framework scripts

Serving Framework Scripts from inside the application

MicrosoftAjax scripts

WebForms scripts

ScriptManager registration

Trending Articles

Practice Sheet of Right form of verbs for HSC Students

Download: FK ft Shenky – Nakuyewa ”Prod by: Shenky”

How to win at Markstrat (Markstrat Tips and Tricks) – Vodites

Ominde Commission Report and Recommendations – Ominde Report of 1964

Bureau of Internal Revenue: Regional Offices (Directory)

GO 53 on Enhancement of Ex-gratia upto 5 Lakhs Toddy Tappers in Telangana

Cakewalk CA-2A Leveling Amplifier v2.0.1.97 WiN, v2.0.1.96 OSX Incl Keygen

Mp3 Download: Mdu - Kunjenjenjena

How the kill the job , when DTP request running for long hours.

Microsoft Intune から展開しているアプリのアップデートについて

18-year-old girl was beaten for half an hour by two Northampton men in 'an...

Car crash in Dunton Bassett leaves driver in critical condition

Macky 2, Two Others In Road Accident

Application log 00000000000000089514: Could not convert queue DLVST90CLNT

Detroit mafia: D’Anna Brothers agree to plea deal

Delivery block field greyed out using VA02

Muloraki Au

【個人撮影】スマホのプライベート映像♪「中に出さないで///」カラオケ屋での生ハメ撮りが流出ｗ【リベンジポルノ】＠PornHub

BREAKING NEWS: Diamond Platnumz Is Reported Dead After Ghastly Car Accident

FIAT 500 B0111 B0112