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>

上面代碼核心就是 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>

而我期望在 JeenalerenenearWerjilakaw 專案的自定義控制元件 UserControl1.xaml 上使用這個 Brush.ColorBrush.ThemeColorBrush 資源，如下面代碼

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

此時的設計器和代碼都不能作業，將會在設計器提示找不到資源

接下來新建 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>

在 JeenalerenenearWerjilakaw 的 csproj 添加如下代碼

  <ItemGroup>
    <Page Update="Properties\DesignTimeResources.xaml">
      <Generator>MSBuild:Compile</Generator>
      <SubType>Designer</SubType>
      <ContainsDesignTimeResources>true</ContainsDesignTimeResources>
    </Page>
  </ItemGroup>

當前的 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>

以上代碼是用在 SDK 風格的 csproj 檔案上，如果當前專案檔案非 sdk 風格，請參閱從以前的專案格式遷移到 VS2017 新專案格式

接下來保存代碼，然后關閉 VisualStudio 清理快取檔案，打開 VisualStudio 可以看到，當前設計器和代碼都能作業

本文代碼放在 github 和 gitee 歡迎下載執行

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

然而在有 Resharper 的 VisualStudio 上，這個配置在 Resharper 2020 的一些版本是不認識的，此時將會讓 Resharper 找不到資源參考，而沒有自動跳轉和補全的功能，好在 Resharper 對于專案格式的支持不夠好，咱可以使用黑科技來解決此問題，在 Resharper 的 2021 版本也修了這個問題，因此在新版本的 Resharper 是不需要加以下代碼

在 Resharper 中，將會根據 ApplicationDefinition 定義去讀取應用資源檔案，但是在讀取時將會忽略 Condition 內容，于是咱就可以嘗試創建一個叫 App_MakeReshaperHappy.xaml 的檔案，用來讓 Resharper 開森，在 csproj 中添加如下代碼，用來參考應用資源，但實際上又不會用上此資源

    <ApplicationDefinition Include="App_MakeReshaperHappy.xaml" Condition="false">
      <Generator>MSBuild:Compile</Generator>
      <SubType>Designer</SubType>
    </ApplicationDefinition>

上面代碼中，使用了 Condition 為 false 讓構建時實際忽略了此檔案，否則將會在構建時報告不能在 WPF 類別庫中定義 ApplicationDefinition 元素，為什么不能叫 App.xaml 檔案？原因是在 SDK 風格的 csproj 中，默認將會加上 EnableDefaultApplicationDefinition 自動加上默認的 ApplicationDefinition 元素，只要有檔案叫 App.xaml 的，那么將會自動識別為 ApplicationDefinition 元素，此元素將會讓 WPF 構建時報告不能在類別庫中定義，而如果設定 EnableDefaultApplicationDefinition 為 false 那 Resharper 又會不認此檔案，經過了 lsj 工具人的摸索，發現使用上文方法是最穩的

在 App_MakeReshaperHappy.xaml 檔案里面存放以下代碼，用來讓 Resharper 智能感知能在設計時找到資源

<Application x: xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
                    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
    <!--這個檔案只是為了讓Reshaper的智能感知開心-->
    <Application.Resources>
        <ResourceDictionary>
            <ResourceDictionary.MergedDictionaries>
                <!--以下替換為你自己的路徑，我推薦參考的是設計時資源檔案-->
                <ResourceDictionary Source="Properties/DesignTimeResources.xaml" />
            </ResourceDictionary.MergedDictionaries>
        </ResourceDictionary>
    </Application.Resources>
</Application>

以上代碼必須要自己定義型別，然后繼承 Application 同時有 x:Class 內容才可以，這個檔案的檔案名和類名要求一定包含 App 這三個字符，同時檔案名和類名需要相同

以上代碼放在 github 和 gitee 歡迎下載執行

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/285411.html

標籤：WPF

上一篇：WPF教程十三：自定義控制元件進階可視化狀態與自定義Panel

下一篇：dotnet 讀 WPF 源代碼筆記 WriteableBitmap 的渲染和更新是如何實作