visual-studio - 特定文件的 Visual Studio 自定义编辑器

Question

语境：

我正在为 Visual Studio 2017 创建自定义项目模板，效果很好。在这个项目模板中，我发出了一个名为“ manifest.json ”的文件。

我需要为“ manifest.json ”文件创建自定义编辑器\设计器，当用户在“解决方案资源管理器”中双击此文件时，它会打开我的自定义编辑器。

我已经在 Microsoft Doc 上找到了几篇文章（例如Create custom editors and Designers），并找到了一些关于创建自定义编辑器和自定义设计器的 GitHub 示例（例如Editor_With_Toolbox、SingleFileGenerator、WPFDesigner_XML和Snippet Designer）。

问题：

• 大多数文章、示例和文档都解释了如何将自定义编辑器与特定文件扩展名相关联（在我的情况下，我想将编辑器与特定项目中的特定文件“ manifest.json ”相关联）。
• 与单个文件生成器相关的文章，它们不适合我的解决方案，因为它们谈到了在设计器中编辑了一个文件，而在解决方案中发出了另一个文件（如 Windows 窗体设计器）。

概括：

我想实现仅针对我的自定义项目模板中的特定文件运行的 Visual Studio 自定义编辑器\设计器。如何做到这一点？

笔记：

• 要在自定义编辑器中关联的文件必须命名为“ manifest.json ”。
• 如果在其他项目类型中有一个名为“ manifest.json ”的文件，则应该执行标准编辑器而不是我的自定义编辑器。

Answer 1

最后，在开源示例支持的大量尝试和错误方法之后，我通过以下步骤解决了我的问题：

1. 像问题中发布的任何示例一样正常实施自定义编辑器（例如Editor With Toolbox）。
2. 在编辑器工厂类（实现的类IVsEditorFactory）内部，在CreateEditorInstance函数内部，您可以设置这样的条件来将编辑器限制为具有特定名称的 JSON 文件：

if (System.IO.Path.GetFileName(pszMkDocument).ToLower() != "manifest.json")
{
    return VSConstants.VS_E_UNSUPPORTEDFORMAT;
}

3. 要将我们的自定义编辑器限制为特定的自定义项目，我们需要在模板项目文件 ( ) 中使用元数据（要了解有关元数据的更多信息，查找 msbuild 元数据）标记我们的目标文件，ProjectTemplate.csproj如下所示：

<Content Include="manifest.json" >
    <IsWebExtensionManifest>true</IsWebExtensionManifest>
</Content>

4. 为了检查编辑器工厂中的元数据，我们将继续我们在CreateEditorInstance函数中的工作，如下所示：

   4.1 我们已经将这两个参数传递给CreateEditorInstance函数：(IVsHierarchy pvHier和uint itemid)。

   4.2 使用这2个参数来获取IVsBuildPropertyStorage父项目（网上有一些代码示例）。

   4.3 使用此代码检查我们的标记元数据：

buildPropertyStorage.GetItemAttribute(itemid, "IsWebExtensionManifest", out string propVal);
if (!Convert.ToBoolean(propVal))
{
    return VSConstants.VS_E_UNSUPPORTEDFORMAT;
}

使用此自定义编辑器完成我的自定义项目后，我将发布其 GitHub 链接以更清晰。