WPF 给类库设置设计时使用的资源字典

在开发 WPF 类库时，由于类库里面没有存在 App.xaml.cs 文件，而在对单个 XAML 进行开发时，设计器将会因为找不到资源文件的存在，而拿不到资源。本文告诉大家简单的方法，给设计器设置仅在设计时引用的资源

在 WPF 的 XAML 中，如果对每个 XAML 控件都引用相同的资源，此时设计时将可以愉快的跑起来，然而在运行时将会重复创建资源影响性能。在开发 WPF 应用时，在入口项目里面，因为入口处有 App.xaml 文件，在这个文件里面加上了各个项目的引用，此时设计器就能知道当前项目引用的 XAML 资源字典，因此设计器就能工作

但是在开发类库的时候，类库不知道最终的入口项目是哪个，因此也就不知道当前程序在运行的时候，将会引用

最佳的方法是和 Blend 一样，在设计时让设计器引用上某些资源，这样设计器就能工作

实现方法是在类库里面添加特殊的文件，这个特殊的文件有文件夹和命名的要求，这是在 VisualStudio 的设计器里面写常量固定的路径

在项目里面新建 ​​Properties​​​ 文件夹，在 ​​Properties​​ 文件夹里面新建 DesignTimeResources.xaml 资源字典文件，大概如下

​​​

这个文件的命名规则是有约定的，不推荐自己修改。在 csproj 上添加如下代码

 

 

<ItemGroup>
<Page Update="Properties\DesignTimeResources.xaml">
<Generator>MSBuild:Compile</Generator>
<SubType>Designer</SubType>
<ContainsDesignTimeResources>true</ContainsDesignTimeResources>
</Page>
</ItemGroup>
1.
2.
3.
4.
5.
6.
7.

上面代码核心就是 ContainsDesignTimeResources 这个属性。理论上可以给任意的 xaml 文件设置这个属性，但是 XAML 设计器在很多 VS 版本上只读取此路径的文件

在 DesignTimeResources.xaml 资源字典添加对其他资源字典的引用，即可实现让类库的设计器找到资源，而在运行时是不会加载资源到内存

例如我新建了类库项目 JeenalerenenearWerjilakaw 项目。我在 JeenalerenenearWerjilakaw 项目里面添加了资源字典 ColorBrushResourcesDictionary.xaml 资源字典，在里面存放颜色画刷，代码如下

 

 

<ResourceDictionary xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:local="clr-namespace:JeenalerenenearWerjilakaw">
<SolidColorBrush x:Key="Brush.ColorBrush.ThemeColorBrush">#FF565656</SolidColorBrush>
</ResourceDictionary>
1.
2.
3.
4.
5.

而我期望在 JeenalerenenearWerjilakaw 项目的自定义控件 UserControl1.xaml 上使用这个 Brush.ColorBrush.ThemeColorBrush 资源，如下面代码

 

 

<Grid>
<Border Background="{StaticResource Brush.ColorBrush.ThemeColorBrush}" Margin="10,10,10,10"></Border>
</Grid>
1.
2.
3.

此时的设计器和代码都不能工作，将会在设计器提示找不到资源

​​​

接下来新建 ​​Properties\DesignTimeResources.xaml​​ 资源字典文件，在这个资源字典文件里面添加如下代码

 

 

<ResourceDictionary xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
<ResourceDictionary.MergedDictionaries>
<ResourceDictionary Source="../ColorBrushResourcesDictionary.xaml"></ResourceDictionary>
</ResourceDictionary.MergedDictionaries>
</ResourceDictionary>
1.
2.
3.
4.
5.
6.

在 JeenalerenenearWerjilakaw 的 csproj 添加如下代码

 

 

<ItemGroup>
<Page Update="Properties\DesignTimeResources.xaml">
<Generator>MSBuild:Compile</Generator>
<SubType>Designer</SubType>
<ContainsDesignTimeResources>true</ContainsDesignTimeResources>
</Page>
</ItemGroup>
1.
2.
3.
4.
5.
6.
7.

当前的 csproj 的所有代码看起来如下

 

 

<Project Sdk="Microsoft.NET.Sdk.WindowsDesktop">

<PropertyGroup>
<TargetFramework>netcoreapp3.1</TargetFramework>
<UseWPF>true</UseWPF>
</PropertyGroup>

<ItemGroup>
<Page Update="Properties\DesignTimeResources.xaml">
<Generator>MSBuild:Compile</Generator>
<SubType>Designer</SubType>
<ContainsDesignTimeResources>true</ContainsDesignTimeResources>
</Page>
</ItemGroup>
</Project>
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.

以上代码是用在 SDK 风格的 csproj 文件上，如果当前项目文件非 sdk 风格，请参阅 ​ ​从以前的项目格式迁移到 VS2017 新项目格式​​

接下来保存代码，然后关闭 VisualStudio 清理缓存文件，打开 VisualStudio 可以看到，当前设计器和代码都能工作

​​​

本文代码放在 ​ ​github​​​ 和 ​ ​gitee​​ 欢迎下载执行

​ ​WPF Design Time Support (Part 2) · jbe2277/waf Wiki​​

我搭建了自己的博客 ​ ​https://blog.lindexi.com/​​ 欢迎大家访问，里面有很多新的博客。
-----------------------------------
©著作权归作者所有：来自51CTO博客作者lindexi的原创作品，请联系作者获取转载授权，否则将追究法律责任
WPF 给类库设置设计时使用的资源字典
WPF 给类库设置设计时使用的资源字典_11273245的技术博客_51CTO博客