SYSK 330: How To Use An Embedded Resource From A Sub-Folder

  • Article

If you’re creating a custom client-side control by deriving from System.Web.UI.IScriptControl, you may want to embed the .js files into your assembly instead of having to deploy them to every web site that uses those controls (this is especially valuable if you’re developing a control library). All you need to do is to:

  1. Click on the .js file in the Solution Explore to select it, and then set Build Action (in the properties window) to Embedded Resource.

 

  1. Add the following attribute to your control code-behind file (e.g. MyControl.cs):

 

[assembly: System.Web.UI.WebResource("ControlLibrary.MyControl.js", "text/javascript")]

 

  1. In GetScriptReferences, instead of setting the Path property, use the parameterized constructor as follows:

 

public IEnumerable<ScriptReference> GetScriptReferences()
{
return new ScriptReference[] { new ScriptReference("ControlLibrary.MyControl.js", "ControlLibrary") };
}

 

However, if you place your JavaScript files in a subfolder (e.g. \ControlLibrary\Scripts\MyControl.js), then you will have to add the folder name to the dotted resource name above, e.g. ControlLibrary.Scripts.MyControl.js.

 

If you don’t add the folder name, you’ll probably see a run-time error message like this:

System.InvalidOperationException: Assembly ControlLibrary, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null' contains a Web resource with name 'ControlLibrary.MyControl.js', but does not contain an embedded resource with name 'ControlLibrary.MyControl.js'.