Visual Studio Extension在调试时可以工作,但是当我安装VSIX时却无法工作

问题描述

我试图用C#制作一个VSIX插件。当我处于开发模式时,该插件可以正常工作。但是当我尝试通过双击VSIX来安装插件时,它无法正常工作。 我已经阅读了一些文档,有些人说要打包并进行安装。但是,当我将“ Generate .pkgdef file”选项设置为“ True”时,出现了类似“-CreatePkgDef:error:ArgumentException:在此程序集中找不到Visual Studio注册属性”的错误。并且程序集应包含在程序集“ Microsoft.VisualStudio.Shell.Framework”版本“ 16.0.0.0”中定义的属性“ Microsoft.VisualStudio.Shell.RegistrationAttribute”的实例。

基本上,我想部署VSIX。我该怎么办?有人可以帮忙吗? 谢谢。

解决方法

我遇到了真正的问题。实际上,我正在使用ITeamExplorerNavigationItem2在团队资源管理器中添加一个按钮。 我正在使用公共System.Drawing.Image Image属性来控制按钮Icon。

public System.Drawing.Image Image => null // Button comes up  without any button icon

public System.Drawing.Image Image => System.Drawing.Image.FromFile("MyImage.png"); // button does not show up in the team explorer

我怀疑的是,在调试过程中,它正在查找“ MyImage.png”的路径,但是在运行时,图像未打包到VSIX,因此,它找不到.png路径,因此没有找到。显示图标和按钮。

要解决此问题,我实际上向项目添加了 Resource.resx 文件,并在其中添加了图像。由于resource.resx文件是在编译期间添加到VSIX文件的,因此在安装后将正确显示。 修改后的代码

public System.Drawing.Image Image => Resource.MyImage;
,

在.vsixmanifest文件中声明了VSIX安装的资产。就您而言,您已经:

  <Assets>
    <Asset Type="Microsoft.VisualStudio.MefComponent" d:Source="Project" d:ProjectName="%CurrentProject%" Path="|%CurrentProject%|" />
    <Asset Type="Microsoft.VisualStudio.VsPackage" d:Source="Project" d:ProjectName="%CurrentProject%" Path="|%CurrentProject%;PkgdefProjectOutputGroup|" />
  </Assets>

但是,第二项应该是不必要的。仅在注册新程序包时才需要Pkgdef文件-即从Microsoft.VisualStudio.Shell.Package或Microsoft.VisualStudio.Shell.AsyncPackage继承的类(这些类用于与您使用的扩展点不同的扩展名)。由于您的MEF组件已经注册(这似乎是您唯一需要的东西),因此VSIX应该已经可以安装。

要详细介绍这些内容,在安装VSIX时,它将查看这些资产,然后根据它们重新配置VS。

  • MefComponent意味着应将该程序集添加到Visual Studio的MEF目录中,该目录随后将适当地发现任何导出的零件。我看不到您实际导出的任何内容,因此那里可能缺少某些内容。您可能还需要将[Export(typeof(ITeamExplorerNavigationItem))]添加到您的班级中(但我对该功能不熟悉,因此我不太满意。)
  • VsPackage将获取一堆注册属性并将其转换为注册表项(这实际上是.pkgdef文件所包含的内容)。安装后,这些将合并到Visual Studio的注册表配置单元中。

编辑(回复评论): 如果问题是图像未加载,则可能是因为VSIX不包含图像,或者是因为您未使用正确的文件路径。默认情况下,将相对于devenv.exe所在的文件夹解析所有文件路径。假设您的图片位于DLL的旁边,则可能需要执行以下操作:

string assemblyFolder = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
string iconPath = Path.Combine(assemblyFolder,"MyImage.png");

您可以使用诸如过程监视器(procmon)之类的工具来确切查看过程未能加载的路径。 (我不知道为什么它在调试时会起作用,但在安装时却不起作用。)