How to use shared resource file between projects in one solution?

Yuriy picture Yuriy · Oct 22, 2010 · Viewed 28.5k times · Source

I have a problem with resource files.

I have a solution with two projects. The first project contains ImageResource.resx file with the images that I use. Every Form in this project can access this file from the designer. But I can see in the designer ImageResource.resx file to use it from second project (Reference to second project is present).

I have added the ImageResource.resx file as a link to my second project. And I saw it in the designer! But when I use an image from this resource in the second project Visual Studio modified my original file (It sets the namespaces, and other..) and my solution breaks. Also Visual Studio tells me that ImageResource.resx is present in two dll's first_project.dll and second_project.dll

Can anybody help me with How to correctly use shared resources between projects?

Answer

Yuriy picture Yuriy · Apr 26, 2012
  1. The correct way to share resources is to create a global shared project. Create a new Project with the name Resources:

Solution Explorer, showing an example solution, which contains a project named *Resources*

  1. Next we must add some resources (such as icons) to the project. Do this as usual. Go to the projects setting, select tab Resources and Add Existing File… to the project. We can see that the icon is added to the project and was copied to the local folder:

For example, the Resources project's Resources tab shows a picture of a puppy, and the Solution Explorer shows that the Resources project's Resources folder includes the picture of the puppy

  1. Next step consists of adding this icon to the other project(s). Note the important difference, you need to add this icon as a link!

    Adding as a link avoids the resource duplication. Create a new Project within the same solution and name it e.g. Main. Create some folder in this new project, naming it Resources (the logical name for our purpose). Then right click on this folder, select Add Existing Item… and choose the image file from the shared project folder. Make sure to use Add As Link here! If done correctly the icon of the newly added file will look slightly different (see below):

In the *Add Existing Item* dialog, choose the *Add As Link* option from the *Add* button's drop-down list

Added resource's icon must look like this

In Solution Explorer, the Main project's icon for the puppy Resource has an arrow on the icon, whereas the Resources project's icon for the puppy Resource does not have an arrow on the icon

  1. Now we must set the Build Action for this file to None. For this select the file and go to the Properties Window. There choose None for Build Action. We need to do this to avoid embedding this icon into the assembly:

In Solution Explorer, change the *Main* project's puppy resource's properties. Choose a Build Action of *None*

  1. Finally we need to add the linked files to the Resources of the corresponding project. Open the project Properties for the project where we just added the files. Choose the Resource tab and drag the linked file there:

Drag the linked image from the Solution Explorer's *Main* project's resources to the *Main* project's resources tab's viewing pane

These are the five simple steps you must perform to share icons between projects. You might ask "What are the benefits of this?" The benefits are:

  • We store resources in one place, and
  • It is easy to replace an icon with a new one.