Click here to Skip to main content
Click here to Skip to main content

WebResource ASP.NET 2.0 explained

By , 26 Feb 2006
Rate this:
Please Sign up or sign in to vote.

Introduction

This code drop is part of Redux series. This article started out to be about a dropdown date/time ASP.NET 2.0 server control. So I built the control and all its ancillary JavaScript, along with the images, and then everything was put into a zip file for uploading to the CodeProject. The installation instructions for the control went something like this:

  • Unzip the contents to a folder.
  • Copy the DLL to the Bin folder of your new project.
  • Copy the JavaScript file.
  • Copy the CSS file.
  • Copy the images.

Hey, wait a minute, this is really lame, why all the extra files, why not embed them into the DLL as resources. That was the beginning of three days of hell trying to understand and work with WebResources. I have boiled it down to about twenty lines of working code.

Nothing else on the net gives you an actual working sample and a lot of the information is simply wrong (possibly because it was based on beta versions). Well, this code compiles and runs on the release version of .NET 2.0.

Code snippets

Create a project which looks like this (you can get the control from the download and then just add an ASP.NET project to the solution):

Highlight the three files in MyResources, and in the Properties window, set Build Action to Embedded Resource:

The source for the control is as follows:

namespace MyWebResourceProj
{
  [ToolboxData("<{0}:MyWebResource runat="server"></{0}:MyWebResource>")]
  public class MyWebResource : System.Web.UI.WebControls.TextBox
  {
      protected override void RenderContents(HtmlTextWriter output)
      {
         output.Write(Text);
      }

      protected override void OnInit(EventArgs e)
      {
        base.OnInit(e);
        this.Page.ClientScript.RegisterClientScriptInclude(
           this.GetType(), "Test", 
           Page.ClientScript.GetWebResourceUrl(this.GetType(), 
           "MyWebResourceProj.MyResources.Test.js"));

        // create the style sheet control
        // and put it in the document header
        string csslink = "<link href='" + 
           Page.ClientScript.GetWebResourceUrl(this.GetType(), 
            "MyWebResourceProj.MyResources.Test.css")
           + "' rel='stylesheet' type='text/css' />";
        LiteralControl include = new LiteralControl(csslink);
        this.Page.Header.Controls.Add(include);
      }
  }

This is not a discussion on server controls, so let's focus on the parameters of GetWebResourceUrl:

  • this.GetType() - mandatory, just do it.
  • "MyWebResourceProj.MyResources.Test.js" - this is the most misunderstood parameter and the source of just about all errors. It is composed of [Assembly of this project].[Folder containing resource].[Filename of resource].

No matter what you read anywhere else, including Microsoft's official documentation (which is wrong), if you don't do it this way, you will fail (I know this from personal experience).

Now on to the AssemblyInfo.cs:

[assembly: System.Web.UI.WebResource(
      "MyWebResourceProj.MyResources.Test.css", "text/css")]
[assembly: System.Web.UI.WebResource(
      "MyWebResourceProj.MyResources.Test.js", 
      "text/javascript", PerformSubstitution = true)]
[assembly: System.Web.UI.WebResource(
      "MyWebResourceProj.MyResources.Test.gif", "image/gif")]

You need to specify the resource name exactly as you did in your program code. You need to specify the mime-type. If the file contains JavaScript, you may want to have ASP.NET perform text substitution. For example, you may have a line in JavaScript like:

document.write("<img src='Test.gif'>");

When you embed your images in a resource, you no longer know the name of it as it appears in the resource. To fix this, code as follows:

document.write("<img src='<%=WebResource("MyWebResourceProj" + 
                                 ".MyResources.Test.gif")%>'>");

All the "official documentation" and all the articles on the web say that you can leave [AssemblyName].[FolderName] out. But they are dead wrong!

Note: if you are using this control as the base class of another, see yc4king's note below.

Update

KonstantinG has pointed out an error which only becomes apparent when your namespace is not the same as your assembly name. Previously, I had indicated that the name of the resource is: [Namespace of this project].[Folder containing resource].[Filename of resource], but really it is [Assembly of this project].[Folder containing resource].[Filename of resource]. As always, the best way to find information on this is by using Lutz Roeder's .NET Reflector available at aisto.com.

SmashGrab / Redux series

I have recently started two series of articles here at CodeProject.

Smash and Grab is intended as a series of short articles on one specific code technique. Redux is intended as a series of longer articles which attempts to reduce a complicated topic (like WebResource) into its basic constituent parts and show that once you have all the information, it isn't really that hard. To find the Smash and Grab articles, search for the keyword SmashGrab. To find the Redux articles, search for the keyword Redux. I welcome any contributions to either series, but please follow the guidelines when submitting articles to either.

Conclusion

So there you have it, everything you need to know to use WebResources. This article documented how to place CSS files in the <head> section, extract JavaScript files, dynamically change the contents of a JavaScript file.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

Gary Dryden
Software Developer (Senior)
Canada Canada
No Biography provided

Comments and Discussions

 
GeneralRe: this.GetType() - mandatory, just do it. - EXPLAINED Pinmembersteph7530-Nov-06 8:30 
General[Assembly of this project].[Folder containing resource].[Filename of resource] Pinmembermephix4-Sep-06 5:08 
GeneralRe: [Assembly of this project].[Folder containing resource].[Filename of resource] Pinmemberstmarti22-Jan-07 5:01 
GeneralRe: [Assembly of this project].[Folder containing resource].[Filename of resource] Pinmembercueshot4-Jun-07 9:31 
GeneralRe: [Assembly of this project].[Folder containing resource].[Filename of resource] Pinmembercueshot14-Jun-07 13:44 
GeneralCheck that embedded resource exist before call PinmemberMichael Freidgeim1-Sep-06 17:25 
GeneralRe: Check that embedded resource exist before call Pinmemberstmarti22-Jan-07 5:25 
GeneralEmbedding an aspx PinmemberAndrew de Klerk23-Aug-06 23:14 
Hi does anyone know how to embed an aspx page - and what content type to use. I embedded an aspx and set the content type to "text/html" but it rendered only the html component of the page, and did not do any of the scripting...thanks
GeneralRe: Embedding an aspx PinmemberAdam Selene7-Sep-06 14:47 
GeneralRe: Embedding an aspx PinmemberAndrew de Klerk7-Sep-06 21:02 
AnswerRe: Embedding an aspx PinmemberTalk To The Hand6-Apr-07 21:06 
GeneralWrite out variabel or text in Embedded resource PinmemberSkoder12-Aug-06 5:55 
QuestionBrowser Caching??? Pinmemberpaul.tyng21-Jul-06 8:42 
AnswerRe: Browser Caching??? PinmemberAdam Selene7-Sep-06 15:00 
JokeSmall note PinmemberArtur M.22-May-06 2:04 
QuestionRe: Small note Pinmemberoujima6714-Jul-06 14:13 
GeneralRe: Small note PinmemberAdam Selene7-Sep-06 15:03 
AnswerRe: Small note Pinmembergedw9922-Mar-07 10:49 
GeneralEmbedded javascript not working. PinmemberLoophole5-May-06 12:37 
GeneralRe: Embedded javascript not working. PinmemberWeninger22-May-06 2:50 
GeneralWebResource access issues in VB.Net Pinmemberamank30-Apr-06 10:17 
QuestionRe: WebResource access issues in VB.Net PinmemberVenkatesh Mookkan15-Dec-06 0:19 
QuestionPage instance is null? Pinmemberasvannat20-Apr-06 6:22 
AnswerRe: Page instance is null? PinmemberLoophole5-May-06 12:44 
GeneralRe: Page instance is null? Pinmemberasvannat8-May-06 7:47 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140421.2 | Last Updated 26 Feb 2006
Article Copyright 2006 by Gary Dryden
Everything else Copyright © CodeProject, 1999-2014
Terms of Use
Layout: fixed | fluid