我可以在 VSIX 中检测使用 Visual Studio 工作区保存（未更改）的文档吗？

Question

在我的扩展中，我使用 DTE 进入文档保存事件：

this._events2 = (Events2)this._dte.Events;

//setup document events
this._documentEvents = this._events2.DocumentEvents;
this._documentEvents.DocumentSaved += _documentEvents_DocumentSaved;

我正在将我的扩展迁移到 VS 2017 并想开始使用 Roslyn 的东西而不是 DTE。我想出了如何获取 Visual Studio 工作区并进入工作区更改事件。现在我可以访问所有这些文档事件

    /// <summary>
    /// A document was added to the current solution.
    /// </summary>
    DocumentAdded = 9,

    /// <summary>
    /// A document was removed from the current solution.
    /// </summary>
    DocumentRemoved = 10,

    /// <summary>
    /// A document in the current solution was reloaded.
    /// </summary>
    DocumentReloaded = 11,

    /// <summary>
    /// A document in the current solution was changed.
    /// </summary>
    DocumentChanged = 12,

但是没有 DocumentSaved。每次击键时 DocumentChange 都会触发，而 DocumentReloaded 似乎根本不会触发。是否可以仅检测使用 roslyn 工作区事件保存的文档？

Answer 1

要检测文档保存事件（ OnBeforeSave() 或 OnAfterSave() ），您可以实现IVsRunningDocTableEvents3接口。您可以通过将此接口实现到帮助器类并公开公共事件event OnBeforeSaveHandler BeforeSave和公共委托来实现这一点delegate void OnBeforeSaveHandler(object sender, Document document)。

要捕获此事件：runningDocTableEvents.BeforeSave += OnBeforeSave然后您可以在OnBeforeSave方法中编写代码。

我的IVsRunningDocTableEvents3接口实现如下所示：

public class RunningDocTableEvents : IVsRunningDocTableEvents3
{
  #region Members

  private RunningDocumentTable mRunningDocumentTable;
  private DTE mDte;

  public delegate void OnBeforeSaveHandler(object sender, Document document);
  public event OnBeforeSaveHandler BeforeSave;

  #endregion

  #region Constructor

  public RunningDocTableEvents(Package aPackage)
  {
    mDte = (DTE)Package.GetGlobalService(typeof(DTE));
    mRunningDocumentTable = new RunningDocumentTable(aPackage);
    mRunningDocumentTable.Advise(this);
  }

  #endregion

  #region IVsRunningDocTableEvents3 implementation

  public int OnAfterAttributeChange(uint docCookie, uint grfAttribs)
  {
    return VSConstants.S_OK;
  }

  public int OnAfterAttributeChangeEx(uint docCookie, uint grfAttribs, IVsHierarchy pHierOld, uint itemidOld, string pszMkDocumentOld, IVsHierarchy pHierNew, uint itemidNew, string pszMkDocumentNew)
  {
    return VSConstants.S_OK;
  }

  public int OnAfterDocumentWindowHide(uint docCookie, IVsWindowFrame pFrame)
  {
    return VSConstants.S_OK;
  }

  public int OnAfterFirstDocumentLock(uint docCookie, uint dwRDTLockType, uint dwReadLocksRemaining, uint dwEditLocksRemaining)
  {
    return VSConstants.S_OK;
  }

  public int OnAfterSave(uint docCookie)
  {
    return VSConstants.S_OK;
  }

  public int OnBeforeDocumentWindowShow(uint docCookie, int fFirstShow, IVsWindowFrame pFrame)
  {
    return VSConstants.S_OK;
  }

  public int OnBeforeLastDocumentUnlock(uint docCookie, uint dwRDTLockType, uint dwReadLocksRemaining, uint dwEditLocksRemaining)
  {
    return VSConstants.S_OK;
  }

  public int OnBeforeSave(uint docCookie)
  {
    if (null == BeforeSave)
      return VSConstants.S_OK;

    var document = FindDocumentByCookie(docCookie);
    if (null == document)
      return VSConstants.S_OK;

    BeforeSave(this, FindDocumentByCookie(docCookie));
    return VSConstants.S_OK;
  }

  #endregion

  #region Private Methods

  private Document FindDocumentByCookie(uint docCookie)
  {
    var documentInfo = mRunningDocumentTable.GetDocumentInfo(docCookie);
    return mDte.Documents.Cast<Document>().FirstOrDefault(doc => doc.FullName == documentInfo.Moniker);
  }

  #endregion
}

当来自 VS 的任何类型的保存命令（CTRL + S、Save All、Compile、Build 等）被触发时，我已经使用这个实现来格式化一些文档。

如果要从某个命令（如Compile）获取保存事件，则必须在 OnBeforeSave() 方法中添加检查添加更多代码

首先，你必须保持一个强引用CommandEvents var vommandEvents = dte.Events.CommandEvents并添加新的方法到CommandEvents commandEvents.BeforeExecute += CommandEventsBeforeExecute;。

这将起作用，因为CommandsEvents将始终在BeforeSave之前被调用。这就是 Visual Studio 中的工作方式，每个动作都代表一个需要一些步骤和事件的命令（例如，编译命令包含在其工作流程中，在任何事情之前，保存文档事件）。

public override void OnBeforeSave(object sender, Document aDocument)
{
  if (false == myCompileCommandFlag)
    return;

  // write your code here 

}

public void CommandEventsBeforeExecute(string aGuid, int aId, object aCustomIn, object aCustomOut, ref bool aCancelDefault)
{
  string commandName = GetCommandName(aGuid, aId);
  if (0 != string.Compare("Build.Compile", commandName))
  {
    return;
  }
  myCompileCommandFlag= true;
}

public string GetCommandName(string aGuid, int aId)
{
  if (null == aGuid)
    return string.Empty;

  if (null == mCommand)
    return string.Empty;

  Command cmd = mCommand.Item(aGuid, aId);
  if (null == cmd)
    return string.Empty;

  return cmd.Name;
}