如何以分层方式保存Visual Studio项目扩展属性

时间:2016-03-08 15:28:38

标签: c# xml visual-studio msbuild vsix

如何在Visual Studio 2015项目文件中动态创建/修改/删除扩展属性,以便XML维护以下构造:

<ProjectExtensions>
    <VisualStudio>
        <MyProject>
            <MyProjectProperty1>3</MyProjectProperty>
            <MyProjectProperty2>8</MyProjectProperty>
            <MyProjectProperty3>2016</MyProjectProperty>
        </MyProject>
    </VisualStudio>
</ProjectExtensions>

我已经知道如何使用EnvDTE.Globals创建该变体,然后使用类似于以下代码的方式保存值并选择性地保存项目:

EnvDTE.Project oProject = dte.Solution.Projects.Item(1);
Globals oGlobals = oProject.Globals;
oGlobals["MyProjectProperty1"] = "3";

这里的问题是这段代码产生:

<ProjectExtensions>
  <VisualStudio>
    <UserProperties MyProjectProperties1="3" MyProjectProperties2="8" MyProjectProperties3="2016" />
  </VisualStudio>
</ProjectExtensions>

我想过使用IPersistXMLFragmentIVsProjectFlavorCfg组合,但这种方法缺乏从项目文件中读取,编写和删除XML代码的关键概念。 IPersistXMLFragment load方法将XML代码作为字符串,将值加载到字典中,然后管理值。 save方法从管理构造反向回到基于字符串的XML版本。正如我刚才所说,缺少的是从实际项目文件中读取,写入和删除,而无需手动编辑文件并导致项目重新加载。

我还在玩IVsHierarchyMSBuild VSIX接口/对象,但是没有走得太远。

有没有人有任何想法?

1 个答案:

答案 0 :(得分:0)

您可以使用 IVsBuildPropertyStorage。我使用 EnvDTE.Project 对象作为输入。
SetCsprojProperty 将在 csproj 文件的第一个 <PropertyGroup> 中设置该属性,如果它不存在:

private IVsHierarchy GetIVsHierarchyObject(Project project)
{
  string uniqueName = project?.UniqueName;
  int ret = Solution.GetProjectOfUniqueName(uniqueName, out IVsHierarchy hierarchyProject);
  if (ret != VSConstants.S_OK) return null;

  return hierarchyProject;
}

public string GetCsprojProperty(Project project, string name)
{
  IVsHierarchy hierarchyProject = GetIVsHierarchyObject(project);
  if (hierarchyProject is IVsBuildPropertyStorage buildPropertyStorage)
  {
    var result = buildPropertyStorage.GetPropertyValue(name, "", (uint)_PersistStorageType.PST_PROJECT_FILE, out string value);
    if (result == VSConstants.S_OK)
    {
      return value;
    }
  }

  return null;
}

public bool SetCsprojProperty(Project project, string name, string value)
{
  IVsHierarchy hierarchyProject = GetIVsHierarchyObject(project);
  if (hierarchyProject is IVsBuildPropertyStorage buildPropertyStorage)
  {
    var result = buildPropertyStorage.SetPropertyValue(name, "", (uint)_PersistStorageType.PST_PROJECT_FILE, value);
    if (result == VSConstants.S_OK)
    {
      return true;
    }
  }

  return false;
}