从零开始的 .Net Shell 扩展教程 (二) - Shell 图标处理程序 (Icon Handlers)

by acdzh & dave kerr · 2020年3月7日7:23 · 534 WORDS  ·  ~ 2 mins reading time · 0  Visitors | 

使用 .Net 快速创建 Shell 图标处理程序扩展.

介绍

Shell 图标处理程序是在系统中注册的 DLL, 用来自定义图标外观. 在本文中, 我将向您展示如何使用 .Net 和 SharpShell库来创建图标处理程序扩展.

202946

上图: 一个实际的图标处理程序扩展. 此扩展用来更改 DLL 文件的图标, 以指示它们是程序集 (Assemblies) 还是本机 DLL.

系列文章

本文是 ".NET Shell扩展" 系列的一部分，其中包括：

  1. .NET Shell扩展-Shell 上下文菜单
  2. .NET Shell扩展-Shell 图标处理程序
  3. .NET Shell扩展-Shell 信息提示处理程序
  4. .NET Shell扩展-Shell 拖拽处理程序
  5. .NET Shell扩展-Shell 预览处理程序
  6. .NET Shell扩展-Shell 图标叠加处理程序
  7. .NET Shell扩展-Shell 缩略图处理程序
  8. .NET Shell扩展-Shell 属性表
  9. .NET Shell扩展-部署 SharpShell 服务

我们的目标

为了展示 SharpShell 和 Shell 图标处理程序的工作方式, 我们将创建一个 DLL 来更改 *.dll 文件的图标. 对于标准 DLL, 图标将以一种颜色显示, 而对于程序集 DLL (Assemblies), 图标将以另一种颜色显示. 使用 SharpShell 来完成此工作是一件特别容易的事. 这是最终的类的代码:

/// <summary>
/// The DllIconHandler is a Shell Icon Handler exception that
/// shows different icons for native and managed dlls.
/// </summary>
[ComVisible(true)]
[COMServerAssociation(AssociationType.ClassOfExtension, ".dll")]
public class DllIconHandler : SharpIconHandler {
    /// <summary>
    /// Gets the icon
    /// </summary>
    /// <param name="smallIcon">if set to <c>true</c> provide a small icon.</param>
    /// <param name="iconSize">Size of the icon</param>
    /// <returns>
    /// The icon for the file
    /// </returns>
    protected override Icon GetIcon(bool smallIcon, uint iconSize) {
        //  The icon we'll return
        Icon icon = null;
 
        //  Check the assembly name. If it's a native dll, this'll throw an exception.
        try {
            //  SelectedItemPath is provided by 'SharpIconHandlder' 
            //  and contains the path of the file.
            AssemblyName.GetAssemblyName(SelectedItemPath);
        }
        catch (BadImageFormatException) {
            //  The file is not an assembly.
            icon = Properties.Resources.NativeDll;
        }
        catch (Exception) {
            //  Some other eception occurred, so assume we're native.
            icon = Properties.Resources.NativeDll;
        }
 
        //  If we haven't determined that the DLL is native, use the managed icon.
        if (icon == null)
            icon = Properties.Resources.ManagedDll;
        
        //  Return the icon with the correct size. 
        //  Use the SharpIconHandler 'GetIconSpecificSize'
        //  function to extract the icon of the required size.
        return GetIconSpecificSize(icon, new Size((int)iconSize, (int)iconSize));
    }
}

看起来再简单不过了. 现在, 我们将详细研究如何创建图标处理程序扩展.

第一步: 建立项目

首先, 创建一个新的 C# 类库 (C# Class Library) 项目.

提示: 您可以使用 Visual Basic 而不是 C#. 虽然本文中的源代码是 C#, 但是创建 Visual Basic Shell 扩展的方法是相同的.

在这个例子中, 我们将项目叫做 'DllIconHandler'. 将 'Class1.cs' 文件重命名为 'DllIconHandler.cs'.

现在添加下列引用:

  1. System.WIndows.Forms
  2. System.Drawing

System.Windows.Forms 是必需的, 是因为 SharpShell 需要依赖它 (像上下文菜单等等). 因为我们要使用图标, 因此 System.Draeing 也是必需的.

提示: 如果您使用 Nuget 来安装 SharpShell (见 "第二步"), 您就不再需要添加这些引用了 - 它们将会被自动添加

第二步: 引用 SharpShell

现在我们需要添加核心库 SharpShell 的引用. 您可以通过几种不同的方式进行此操作.

添加引用

下载文章顶部名为 "SharpShell Library" 的 zip 文件, 并对下载的 SharpShell.dll 添加引用.

提示: 撰写本文时, 本文的下载是正确的. 如果需要最新版本, 请使用 Nuget (如下所述) 或从 sharpshell.codeplex.com获取该库.

使用 Nuget

如果已安装 Nuget, 则只需要快速 SharpShell 并直接安装即可. 或者在https://www.nuget.org/packages/SharpShell中获取软件包的详细信息.

使用 CodePlex

该页面上的库可能不是最新版本, 但是您可以从 CodePlex 获取最新版本 - 在 SharpShell 的主页上: https://sharpshell.codeplex.com. Nuget 可以下载最新的稳定版本, 而 CodePlex 有可能有 beta 版本, 文章顶部的链接则是在撰写本是时测试通过的版本.

译者注: 这个项目的 CodePlex 主页已经停用了. 请前往 Github 主页查看最新版本.

第三步: 从 SharpIconHandler 继承 (Deriving from SharpIconHandler)

现在我们来为这个图标处理 DLL 添加功能. 使你的类 DllIconHandler 继承 SharpIconHandler:

/// <summary>
/// The DllIconHandler is a Shell Icon Handler exception that
/// shows different icons for native and managed DLLs.
/// </summary>
public class DllIconHandler : SharpIconHandler {
}

现在我们必须实现该类的抽象函数. 右键单击这一行的 SharpIconHandler, 然后选择 "实现抽象类" ('Implement Abstract Class')

译者注: 原文如此. 但在 VS 2019 中未找到此选项. 也可以通过在 DllIconHandler 上按 Alt + Enter, 选择 "实现抽象类" 亦可. (当然自己不使用代码生成, 自己手动补全也是可以的

这将创建一个函数 GetIcon, 我们使用此函数来获取图标.

/// <summary>
/// Gets the icon.
/// </summary>
/// <param name="smallIcon">if set to <c>true</c> provide a small icon.</param>
/// <param name="iconSize">Size of the icon.</param>
/// <returns>
/// The icon for the file.
/// </returns>
protected override Icon GetIcon(bool smallIcon, uint iconSize) {
    //  The icon we'll return
    Icon icon = null;
 
    //  Check the assembly name. If it's a native DLL, this'll throw an exception.
    try {
        //  SelectedItemPath is provided by 'SharpIconHandlder' 
        //  and contains the path of the file.
        AssemblyName.GetAssemblyName(SelectedItemPath);
    }
    catch (BadImageFormatException) {
        //  The file is not an assembly.
        icon = Properties.Resources.NativeDll;
    }
    catch (Exception) {
        //  Some other eception occurred, so assume we're native.
        icon = Properties.Resources.NativeDll;
    }
 
    //  If we haven't determined that the DLL is native, use the managed icon.
    if (icon == null)
        icon = Properties.Resources.ManagedDll;
    
    //  Return the icon with the correct size. Use the SharpIconHandler 'GetIconSpecificSize'
    //  function to extract the icon of the required size.
    return GetIconSpecificSize(icon, new Size((int)iconSize, (int)iconSize));
}

GetIcon 被调用, 以获取当前选中的文件的图标 (一个 Icon 对象). 用户选择的文件在属性 SelectedItemPaths 中.

如果 shell 明确要求一个小图标, smallIcon 会被设置成 true. 通常我们可以忽略它, 因为 shell 同样会提供要求的图标的大小, 如 iconSize.

基类中有一个辅助函数 GetIconSpecificSize, 它可以从 Icon 对象中获取正确大小的图标并返回. 如果不使用这个函数, 系统将会获取第一个图标并自行调整大小, 这通常不是您想要的结果.

第四步: 处理 COM 注册

还有一些事情要做. 首先, 我们必须将 COMVisible 属性添加到我们的类中.

[ComVisible(true)]
public class DllIconHandler : SharpIconHandler

这是因为, 尽管 SharpShell 几乎隐藏了所有的 COM 管道, 但是这个类自身仍然是一个 COM 服务 - 所以它必需对 COM 可见.

接下来, 我们必须给这个程序集一个强名称 (strong name). 有很多方式可以实现此需求, 不过我们有一个最好的方法. 为此, 我们需要在项目上单击鼠标右键, 然后点击 "属性", 然后转到 "签名", 选择 "为程序集签名", 单击 "选择强名称密钥文件" 下的下拉列表, 选择 "新建". 之后新建一个密钥, 您可以根据需要对密钥进行密码保护, 但这不是必需的.

最后一步, 我们需要将我们的扩展与一些文件类型关联. 我们可以通过 COMServerAssociation 属性 (由 SharpShell 提供) 来做到这一点:

[ComVisible(true)]
[COMServerAssociation(AssociationType.ClassOfExtension, ".dll")]
public class DllIconHandler : SharpIconHandler

那么, 我们在这一步都做了什么? 我们告诉 SharpShell 当注册这个服务时, 我们希望它与 .dll 文件的类型进行关联. 这意味着, 我们不仅可以使其对任何文件名以 .dll 结尾的文件有效, 同样对同类的文件同样有效. 从根本上来讲, 多数情况下, 这些文件与 *.txt 具有相同的图标.

译者注: 这块可以看一下上一篇文章中这部分的解释

您可以将其与文件夹, 驱动器, 未知文件, 以及特定的扩展名相关联. 有关此功能的完整文档, 请访问SharpShell CodePlex页面上的COM 服务关联.

译者注: 这个页面已经停止服务了. 文档请访问此 Github链接.

就这样, Build 该项目将创建 DllIconHandler 程序集. 这个程序集可以作为一个 COM server 进行注册, 添加到图标处理系统中, 并为 DLL 文件提供彩色的图标.

调试 Shell 扩展

如果您看过 .Net Shell 扩展 - 上下文菜单 一文, 可能会会想起工具 'Server Manager'. 这是一个包含在 SharpShell 源码中的工具, 可以用来帮助调试 Shell 扩展.

提示: 如果您想要这个工具的最新版本 可以从 CodePlex 页面预先构建

译者注: 请前往 Github release 页面下载. 另外如果使用 scoop 的话, 同样可以在我的 buckets 中找到该程序

打开 Server Manager, 然后使用 'File' > 'Load Server' 来加载构建好的的 server 文件（DLL）. 您同样可以直接将 server 文件拖拽进主窗口. 选中这个 server , 右侧将会显示它的一些细节信息. 选中这个服务.

现在按下 'Test Server' 或使用 'Server > Test'. 这将打开测试 Shell, 该 Shell 将模拟将要对服务进行的调用, 就像 Windows Shell正在进行调用一样. 因为这是一个托管应用程序, 因此您可以快速将调试器附加到这个 Shell 上, 然后查看您的服务是怎么运行的. 它可以让你测试你的服务, 而不需要在系统安装或注册它, 这将节省大量时间 (当在资源管理器中进行实际测试时, 您将不得不多次重启资源管理器来释放您的 dll, 这样您才可以更新您的 dll 文件).

当测试 Shell 图标处理扩展时, 注意下面几点:

  1. 仅有匹配 COM 服务关联的 shell 项才会被测试
  2. 仅右侧的列表视图才会测试图标, 左侧的文件夹视图将使用标准 shell 图标

效果如下:

203018

安装和注册 Shell 扩展

您可以查看文章 ".Net Shell 扩展 - 上下文菜单" 中的 "安装和注册 Shell 扩展" 部分, 以获取有关如何安装和注册这些扩展的详细信息, 过程是相同的.

有用的资源

[How to Create Icon Handlers]: MSDN 上关于 Shell 图标处理程序的资源. 注意, 这些资源全部用于 C 和 C++.

CodePlex上的SharpShell: SharpShell 项目的所在地-包括文档，讨论以及最新的源代码和发行版. (译者注: 已迁移至 Github)

What's Next?

随着时间的推移, SharpShell 将提供一种使用 .Net 创建所有可用 Shell 扩展的机制. 到目前为止, 上下文菜单扩展, 图标处理程序和信息提示处理程序已完全受支持 - follow CodePlex项目以在添加新功能时保持最新状态.

历史

  • 2015年1月19日: 最新版本

License

本文以及所有相关的源代码和文件均已获得 The Code Project Open License（CPOL） 的许可.

译注

  1. 文章来源: .NET Shell Extensions - Shell Icon Handlers - CodeProject

  2. 原文作者: Dave Kerr, A softer Developer from UK. Blog: www.dwmkerr.com, Github: dwmkerr@Github

  3. 本文最早发表于 2015年1月19日, 截至翻译时最新更新为 2015年1月19日, 翻译日期为 2020年3月7日. 互联网日新月异, 请注意信息时效.

  4. 文中的代码均测试通过, 文中除了标有 "译者注" 的部分之外均为原文, 译者水平有限, 如有疑惑之处请戳原文或 PM 我, 谢谢茄子.

  5. 纠结了好久, 最终还是决定代码中的英文注释不翻译. 这部分与代码相关较大, 希望能尽量保持原汁原味.

VersionActionTime
1.0Init2020-03-07 15:23
1.0迁移至 blog2020-04-28 20:28
随便写写 © 2022 acdzh