Menu
i have an ASP.net UserControl that requires the containing page to include a reference to jquery.
In the olden days, i would simply have included a reference to jQuery in the containing page:
<HEAD>
<SCRIPT type="text/javascript" src="Scripts/jquery-1.7.2.min.js"></SCRIPT>
</HEAD>
But my UserControl's dependency on jQuery is an internal implementation detail, that should not be leaking to the outside. How can my userControl dictate that jQuery be included in the final page?
Researching this, i find a lot of confused solutions, calling different functions at different times. i hesitate to mention any of them, because people might think that any of them are valid. i am hoping for the correct answer, not an answer that works.
Different solutions involve calling:
this.Page.ClientScript.RegisterClientScriptInclude during Renderthis.Page.ClientScript.RegisterStartupScript during Renderthis.Page.ClientScript.RegisterStartupScript during Page_Loadthis.Page.ClientScript.RegisterStartupScript during a button clickPage.Header.Controls.Add(new LiteralControl( { Text = "<script type=\"text/javascript\" src=\"...\"></script>";);<SCRIPT> element in your userControl.ascx fileRegisterClientScriptBlock during OnPreRenderMy confusion is centered around:
RegisterClientScriptInclude vs RegisterStartupScript?Page_Load vs Render vs PreRender vs a button click?RegisterXxxxScriptXxx the path to "Scripts/jquery-1.7.2.min.js"?Short version: How do i convert
<%@ Page Title="Home Page" Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs"
Inherits="_Default" %><!DOCTYPE html>
<html>
<head runat="server">
<script type="text/javascript" src="Scripts/jquery-1.7.2.min.js"></script>
for use in a UserControl:
<%@ Control Language="C#" AutoEventWireup="true" CodeFile="MySuperCoolControl.ascx.cs" Inherits="Controls_MySuperCoolControl" %>
466
JQuery is a JavaScript library. It is helpful and make easy to handle HTML DOM (Document Object Model), Events and Animation and Ajax functionalities. JQuery reduce code compared to JavaScript. Mostly we use JQuery or JavaScript for client side activities and make Ajax call to ASP.NET Web form/mvc, Web service and WCF.
Like any other JavaScript library, jQuery is added to a webpage by placing the script tag inside the head tag with the src of the script tag pointing towards the jQuery library, as shown below. There are two main ways to point the src towards the jQuery library: Downloading the jQuery library.
After the ASP.NET MVC Framework is installed a new ASP.NET MVC Web Application project should be created. Next, download jQuery, get the Packed or Minified version and place it into the Content folder of the the new web application project. Add a reference to the jQuery file put in the Content folder.
You can use google hosted jquery as follows:
<script src="//ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min.js" type="text/javascript"></script>
You can use a ScriptManagerProxy on the UserControl and a ScriptManager on the parent or master page.
See How Do You Use ScriptManagerProxy In a custom ASP.NET Control
This would take care of "Giving RegisterXxxxScriptXxx the path to "Scripts/jquery-1.7.2.min.js" and remove the need to worry about it during the Page_Load/Page_PreRender events.
As for "When would i want to use RegisterClientScriptInclude vs RegisterStartupScript?"
RegisterClientScriptInclude registers an external JS file to be included in the page. RegisterStartupScript includes a block of inline executable script in the page, which is not in an external file.
31
[this is only relevant if your user control is to be used in-house. If it's for distribution then it won't be of much help]
Take a look at this link:
http://www.codeproject.com/Articles/196727/Managing-Your-JavaScript-Library-in-ASP-NET
The article suggests creating methods to generate references to javascript libraries such as jQuery, so that if you want to use it in a page you simply call JavascriptLoader.IncludeJQuery() [or whatever you have called your method].
Now what I have done is to take it a step further by creating those methods in an assembly that I have placed in the GAC so that it is available to all my .net web applications. Now, wherever I want to use jQuery, that method is already available. The best thing being that if I call the method in a user control, and call it again in another user control, and again on the page, it still only registers the library once. If I decide to upgrade to a newer version of jQuery, I just change my dll, and it's changed everywhere.
27
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
