将图标作为资源嵌入到 WPF 应用程序中

Question

我正在尝试将一个图标嵌入到我的 WPF 应用程序中，以便我可以使用以下代码将其拉出以用作 Windows 7 JumpList 中的图标：

newScene.IconResourcePath = System.Reflection.Assembly.GetEntryAssembly().Location;
newScene.IconResourceIndex = 0;

我已使用以下方法使其工作：http://dennisdel.com/?p=38

但是，这似乎不是最好的方法，而且看起来就像应该有一种更简单的方法可以将图标资源嵌入到我的应用程序中，同时仍然保留在我的程序的应用程序属性中选中的“图标和清单”选项。

我尝试了多种方法，包括将图标构建操作设置为资源和嵌入资源，但每次我在资源编辑器中打开 .exe 时，图标都不会出现。

有什么建议吗？

Answer 1

Visual Studio 没有提供从 MSBuild 任务执行 Win32 资源编译器的方法，也没有用于创建原始资源的嵌入功能。因此，您的选择是：

1. 如链接文章中所述“手动”创建 .res 文件，或者
2. 添加构建任务，以便您可以从 .csproj 调用 Win32 资源编译器

首先，我将解释五种不同的版本之间的差异.exe 或 .dll 文件中可以存在的各种“资源”，包括 JumpList 所需的“Win32 资源”。

然后，我将解释如何构建自定义构建任务，该任务允许您在 C# 或 VB.NET 可执行文件中嵌入任意 Win32 资源。

---

Win32 可执行文件中的五种资源

.exe 或 .dll 文件中可以存在五种不同类型的“资源”：

• Win32 资源
• NET Framework“嵌入式资源”
• ResourceSet 中的 CLR 对象
• XAML 资源
• WPF 资源（内部的对象） a ResourceDictionary)

Win32 资源

原始类型的资源是 Win32“资源”。这种资源在 .rc 文件中定义，并且具有编号或命名的资源，每个资源都有一个类型和一个数据块。

Win32 资源编译器 rc.exe 将 .rc 文件编译为二进制 .res 文件，然后可以将其添加到生成的可执行文件中。

Win32 资源可使用 Win32 FindResource 和 LoadResource 函数来访问。

Win32 资源通过将其添加到 .rc 文件来嵌入到 C++ 应用程序中，该文件被编译为 .res 文件并链接到可执行文件中。它们也可以在事后使用 rc.exe 程序添加。对于 C# 和 VB.NET 应用程序，MSBuild 可以将预构建的 .res 文件添加到它通过 Csc 或 Vbc 编译器创建的可执行文件中，也可以为您构建默认文件。 C# 和 VB.NET 都无法从 .rc 文件构建非默认 .res 文件，并且没有 MSBuild 任务可以为您执行此操作。

您可以通过在 Visual Studio 中使用“文件”->“打开 .exe 或 .dll 文件本身”来查看 .exe 或 .dll 中的 Win32 资源。打开。

典型的 C、C++ 或 MFC 应用程序将具有许多 Win32 资源，例如每个对话框都将由一个资源指定。

典型的 WPF 应用程序仅具有由 C# 或 VB.NET 编译器构建的三个默认 Win32 资源：版本资源、RT_MANIFEST 和应用程序图标。这些资源的内容是根据代码中的 Assembly 属性以及 .csproj 或 .vbproj 文件中的 元素构造的。

这就是 JumpList 正在寻找的资源类型。

嵌入式资源

“嵌入式资源”是 NET Framework 资源。包含这些资源的数据结构由 CLR 以更有利于托管代码访问的方式进行管理。每个资源都由一个字符串名称标识，按照惯例，该名称以与资源关联的类的名称空间开头。

嵌入式资源只是带有名称的二进制数据块。实际的数据类型要么由调用者已知，要么从名称推断，类似于文件系统中的文件。例如，名称以“.jpg”结尾的嵌入资源很可能是 JPEG 文件。

使用 Assembly.GetManifestResourceStream 及其同级 GetManifestResourceInfo 和 GetManifestResourceNames 访问嵌入式资源。

通过将文件添加到项目并将生成操作设置为“嵌入资源”，嵌入式资源将嵌入到 .exe 和 .dll 文件中。

您可以通过在 NET Reflector 中打开 .exe 或 .dll 并查看“资源”文件夹来查看 .exe 或 .dll 中的嵌入式资源。

嵌入式资源通常在 WinForms 中使用，但几乎从未在 WPF 中使用。

资源集 (.resx/.resources)

多个 NET Framework 对象（例如字符串和图标）可以组合在一起形成单个“资源集”数据结构，该数据结构作为单个 NET Framework 存储在 .exe 中嵌入式资源。例如，WinForms 使用它来存储不容易包含在生成的代码中的图标和字符串等内容。

可以使用 CLR 定义的 ResourceManager 和 ResourceSet 类单独检索资源集中的对象。

资源集中的对象由 .resx 文件在源代码中定义。数据可以直接位于 .resx 文件中（如字符串的情况），也可以由 .resx 文件引用（如图标的情况）。构建项目时，每个 .resx 文件指定的内容将序列化为二进制形式，并存储为单个嵌入式资源，扩展名“.resx”替换为“.resources”。

您可以通过以下方式查看资源集中的对象：在 NET Reflector 中打开 .exe 或 .dll，打开资源文件夹，单击“.resources”文件，然后查看右侧窗格中的项目。

许多 WinForms 时代的功能通常使用 .resx 文件和资源集，其方式类似于旧的 Win32 .rc 文件，以将多个资源（例如字符串）存储在一起。 WinForms 本身也使用它们来存储无法放入后台代码的表单上的设置。

尽管 WPF 本身在内部使用 ResourceSet 来存储已编译的 XAML，但 WPF 应用程序几乎从不使用 ResourceSet 中的任意对象。

XAML 资源

WPF XAML 资源是存储在 ResourceSet 内的已编译 XAML 文件。资源集中的名称是原始文件名，将“.xaml”替换为“.g.baml”。内容可以是任何有效的 XAML，最常见的类型是 Window、Page、UserControl、ResourceDictionary 和
应用。

可以使用 Application.LoadComponent() 或通过引用 WPF 上下文中的原始 XAML 文件名来加载 WPF 资源。此外，任何具有后台代码（由 x:Class 指定）的 WPF 资源都将自动加载并应用于在其 InitializeComponent 期间为该类创建的每个对象。称呼。

WPF 资源是通过将 .xaml 文件添加到项目并将其生成操作设置为“资源”、“页面”或“应用程序定义”来创建的。这会导致编译器将文件编译为 BAML 并将其添加到适当的 ResourceSet。

您可以通过在安装了 BamlViewer 加载项的 NET Reflector 中打开 .exe 或 .dll 中的 XAML 资源来查看它，选择“工具”->“XAML”。从菜单中选择 BAML 查看器，并使用 BAML 查看器浏览到 .resources 内的特定 .g.baml 文件。

ResourceDictionary 中的 WPF 资源

在 WPF 中，几乎所有所谓的“资源”都是 ResourceDictionary 中的条目。 ResourceDictionaries 在 XAML 中进行描述，或者在 Windows 和 UserControls 等其他对象中，或者在仅包含 ResourceDictionary 的单独 XAML 文件中。每个都由“x:Key”标识，它可以是任何对象类型。资源本身也可以是任何对象类型。

可以使用 {StaticResource} 和 {DynamicResource} 标记扩展在 XAML 中引用 WPF 资源，也可以使用 FindResource 在代码中加载。

通过将 WPF 资源添加到包含 元素内的 ResourceDictionary 的 XAML 文件并为其赋予 x:Key 属性，可以将 WPF 资源添加到 ResourceDictionary。

WPF 资源在 WPF 中广泛使用，包括画笔、样式、数据、几何图形、模板等。

您可以通过如上所述浏览 XAML 资源并查看 ResourceDictionary 中的每个资源来查看 .exe 或 .dll 中的 WPF 资源标签以查看资源本身。

---

在 C# 或 VB.NET 可执行文件中包含 Win32 资源

如何轻松地将任意 Win32 资源嵌入到 C# 或 VB.NET .exe

从上面的讨论中您会注意到，添加每种类型的C# 或 VB.NET 应用程序的资源（Win32 资源除外）。为了使这变得简单，您可以添加额外的构建任务和目标。方法如下：

1. 构造一个包含单个“Win32ResourceCompiler”构建任务的项目并对其进行编译
2. 创建一个包含单个目标的 .targets 文件，该目标使用此任务自动将 .rc 文件构建为 .res
3. 将您的项目设置为使用生成的结果.res 文件

任务非常简单：

public class Win32ResourceCompiler : ToolTask
{
  public ITaskItem Source { get; set; }
  public ITaskItem Output { get; set; }

  protected override string ToolName { get { return "rc.exe"; } }

  protected override string GenerateCommandLineCommands()
  {
    return @"/r /fo """ + Output.ItemSpec + @""" """ + Source.ItemSpec + @"""";
  }

  protected override string GenerateFullPathToTool()
  {
    // TODO: Return path to rc.exe in your environment
  }
}

.targets 文件也非常简单。内容大致如下：

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

  <UsingTask TaskName="SomeNamespace.Win32ResourceCompiler" AssemblyFile="Something.dll" />

  <PropertyGroup>
    <CoreCompileDependsOn>$(CoreCompileDependsOn);CompileWin32RCFile</CoreCompileDependsOn>
  </PropertyGroup>

  <Target Name="CompileWin32RCFile" Outputs="@(Win32RCFile->'%(filename).res')">
    <Win32ResourceCompiler
      Source="@(Win32RCFile)"
      Output="@(Win32RCFile->'%(filename).res')" />
  </Target>
</Project>

现在，在您的 .csproj 文件中，添加对 .targets 文件的引用：

<Import Project="Win32ResourceCompiler.targets" />

当然，您需要为您的 .rc 文件指定 Win32RCFile 的文件类型：

<ItemGroup>
  <Win32RCFile Include="MyWin32Resources.rc" />
</ItemGroup>

通过此设置，您可以创建传统的 Win32 .rc 文件来指定所有 Win32 资源，包括版本、清单、应用程序图标以及所需的任意数量的其他图标。每次编译时，所有这些 Win32 资源都会添加到您的 .exe 文件中。

这需要一些时间来设置，但从长远来看比手动编辑 .res 文件更令人满意且更简单。

您可以在 .rc 文件中指定多个图标，如下所示：

1 ICON ApplicationIcon.ico
2 ICON JumpListIcon.ico
3 ICON AnotherIcon.ico

此处 是您可以在 .rc 文件中使用的所有资源定义语句的文档。

另请注意，上面的 .targets 文件是临时输入的，尚未经过测试。有关 MSBuild（.csproj 和 .targets）文件语法的文档可以找到 此处和此处 ，并且可以在 c:\Windows\Microsoft.NET\Framework\v3.5 目录中找到 .targets 文件的良好示例）。