Share Resources Across Multiple Projects

• Download VB.NET sample - 279 KB
• Download C# sample - 338 KB

Introduction

In VS 2005 and earlier, resources were flagged as Friend; this meant that, you could use them globally within the project, but could not make them directly available to outside projects. VS 2008 allows you to make resources Public, but this applies to all resources, and namespace issues can make this a bit tricky. If you use a static class, however, resources can be exported in a controlled, organized, and easy to maintain fashion.

Background

I have been working on a large application organized into several projects. One of these is the "core" project, which holds various toolboxes, custom controls, etc. I wanted to put all of the app's icons and images here, too.

We started out using VS 2005, which does not allow the resources of a project to be shared. The workaround turned out to be pretty simple: export the resources using a static class.

After switching to VS 2008, my team decided to stick with using this export class. The structure allowed to pick which resources would be made public, to organize the resources into logical groupings, and to alias resources to show how they are to be used. The aliasing has proven especially useful, as it has allowed us to change an image in only two places -- the resource file and the exporting class -- and leave the rest of our code alone.

The Theory

In the accompanying solution, there is a code module named Shared. This defines the namespace SharedResources, which contains three classes: Icons, Images, and Strings. These classes export icon, image, and string resources, respectively, by using read-only properties. This is what the Images class looks like in VB:

Public Class Images

    Public Shared ReadOnly Property Leave() As Image
        Get
            Return My.Resources.Leave
        End Get
    End Property

    Public Shared ReadOnly Property Page() As Image
        Get
            Return My.Resources.Page
        End Get
    End Property

    Public Shared ReadOnly Property Report() As Image
        Get
            Return My.Resources.Page
        End Get
    End Property

    Public Shared ReadOnly Property User() As Image
        Get
            Return My.Resources.User
        End Get
    End Property

End Class

In C#:

using SharingResources_CS.Properties;
using System.Drawing;

public class Images
{
    
public static Image Leave

    {
        get { return Resources.Leave; }
    }

    public static Image Page
    {
        get { return Resources.Page; }
    }

    public static Image Report
    {
        get { return Resources.Page; }
    }

    public static Image User
    {
        get { return Resources.User; }
    }
}

You can see that the resource Page is exported under two different aliases, as Page and as Report. If we ever wanted to change the Report image, all we would need to do is add the image to the project, then reference it in the Images class.

We could have further broken this down in to additional classes, say, small images for use in menus and toolbars, and large images for panel backgrounds; the Strings class can be divided up into strings for menus, strings for message boxes, and strings for help text.

The Example Solutions

I have written two example solutions, one in VB and one in C#, using VS 2008. Each solution contains two projects. The first one implements the SharedResources namespace. The second initializes a form's menu and title from the exported resources.

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)