How to reference WPF style keys defined in a separate assembly in another library

Question

I have two libraries and a single application assembly project layout and I'm wondering how can I reference styles by their key in one of my libraries that's defined in the other.

My solution layout:

• WpfControls.dll - Holds generic reusable controls such as a WPF based NumericUpDown control as well as other basic controls and some styles as well that I would like to make reusable. For the sake of the example lets say my style key here is defined as MyButtonStyle.
• SpecializedControls.dll - Holds controls that are specialized to our application such as custom composite controls and UserControls in WPF. This is where I'd like to reference the MyButtonStyle style defined in WpfControls.dll assembly.
• Application.exe - This assembly uses controls defined in the SpecializedControls.dll assembly.

I've seen some examples explaining how to do this with a simple single control library and application assembly but in my case I have two assemblies and an application. So in other words in my case I don't have an App.xaml in my second control library where I could use the MergeDictionaries concept. I'm pretty sure if I wanted to I could put a MergedDictionaries reference directly in each controls XAML file to merge all of Generic.xaml defined in WpfControls.dll assembly but my guess is that this would result in styles being redundantly merged into various places in my SpecializedControls assembly which doesn't seem like the best solution. To make matters worse, these dictionaries might also be merged into Application.exe as well, does this begin to bloat my application at runtime?

Can anybody clarify what the recommended or best approach for sharing such styles with the least amount of programtic and resource overhead.

Update: After a bit more testing it appears that I'm having trouble referencing any resource defined within Generic.xaml by it's key even within the same assembly. There may be something totally wrong about how I'm understanding how resource keys work so I'll have to a bit more research as well as looking into ComponentResourceKey. If anybody has any hints or suggestions please help.

Answer 1

Resource lookup in WPF works in a hierarchy: up the logical tree, then application resources, theme resources and finally system resources.

Theme resources can usually be accessed only implicitly (even within the assembly they are defined). This is relevant only for Styles, where the TargetType can be used as the implicit key.

To accomplish what you're trying to do, there are two options:

• Use a ComponentResourceKey. This is a special resource key which allows referencing resources from other assemblies. For example, you can define a brush in WpfControls theme dictionary:

  <LinearGradientBrush x:Key="{ComponentResourceKey TypeInTargetAssembly=local:MyClass, ResourceId=MyBrush}">
      <GradientStop Color="Red" />
      <GradientStop Color="Blue" Offset="1" />
  </LinearGradientBrush>
  

  And then you can reference it in SpecializedControls:

  <UserControl Background="{StaticResource {ComponentResourceKey TypeInTargetAssembly=wpfControls:MyClass, ResourceId=MyBrush}}" />
  

• Use MergedDictionaries to import a dictionary into the application resources. You can do this in the Application assembly, and when the application loads, even controls that are in SpecializedControls would be able to use these resources. You will have a problem with the design-time experience in this scenario, which you can solve by putting a fake App.xaml in SpecializedControls, that would also contain a reference to the dictionary.

Hope this helps,

Aelij.

Answer 2

The accepted answer is correct, I'm Just explaining how to use MergedDictionaries

In App.xaml,

    <Application.Resources>
      <ResourceDictionary>
         <ResourceDictionary.MergedDictionaries>
            <ResourceDictionary Source="pack://application:,,,/-YourDllName-;component/-DirectoryName-/FileName.xaml"/>
            <!-- Use Below syntax if your resource file is not inside a directory(in root) -->
            <ResourceDictionary Source="pack://application:,,,/-YourDllName-;component/FileName.xaml"/>
         </ResourceDictionary.MergedDictionaries>
      </ResourceDictionary>
    </Application.Resources>