visual-studio - 如何判断事件文档是否为文本文档？

Question

我正在开发一个 Visual Studio 扩展，其中一个已实现的命令仅在事件文档是文本文档时才需要可用(例如 Visual Studio 的“切换书签”)。问题是我无法弄清楚如何判断何时是这种情况。

现在我有一个半工作的解决方案。在包的 Initialize 方法中，我订阅了 DTE 的 WindowActivated 事件，然后每当窗口被激活时，我检查窗口 DocumentData 属性是否属于类型文本文档:

protected override void Initialize()
{
    base.Initialize();

    var dte = Package.GetGlobalService(typeof(EnvDTE.DTE)) as EnvDTE.DTE;
    dte.Events.WindowEvents.WindowActivated += WindowEventsOnWindowActivated;

    //More initialization here...
}

//This is checked from command's BeforeQueryStatus
public bool ActiveDocumentIsText { get; private set; } = false;

private void WindowEventsOnWindowActivated(Window gotFocus, Window lostFocus)
{
    if (gotFocus.Kind != "Document")                
        return; //It's not a document (e.g. it's a tool window)

    TextDocument textDoc = gotFocus.DocumentData as TextDocument;
    ActiveDocumentIsText = textDoc != null;
}

这种方法的问题在于 1) Window.DocumentData is documented as ".NET Framework internal use only" , 和 2) 当在设计模式下打开同时具有代码 View 和设计 View (例如 .visxmanifest 文件)的文档时，这会产生误报。

我试过使用IVsTextManager.GetActiveView同样，但这将返回打开的最后事件 TextView - 因此，如果我打开一个 .txt 文件，然后打开一个 .png 文件，它会返回 .txt 文件的数据，即使它不是事件的不再记录。

那么，我该如何检查事件文档是文本文档，还是可以拥有设计器的文档的代码 View ...如果可能，不使用“未记录的”类/成员？

更新:我找到了一个稍微好一点的解决方案。在窗口内激活处理程序:

ActiveDocumentIsText = gotFocus.Document.Object("TextDocument") != null;

至少this one is properly documented , 但我仍然遇到设计师误报的问题。

Answer 1

我终于明白了。这有点棘手，但它有效并且 100%“合法”。这是食谱:

1- 使包类实现 IVsRunningDocTableEvents .让所有的方法都只是return VSConstants.S_OK;

2- 将以下字段和以下辅助方法添加到包类中:

private IVsRunningDocumentTable runningDocumentTable;

private bool DocIsOpenInLogicalView(string path, Guid logicalView, out IVsWindowFrame windowFrame)
{
    return VsShellUtilities.IsDocumentOpen(
        this,
        path,
        VSConstants.LOGVIEWID_TextView,
        out var dummyHierarchy2, out var dummyItemId2,
        out windowFrame);
}

3- 将以下内容添加到包类的 Initialize 方法中:

runningDocumentTable = GetService(typeof(SVsRunningDocumentTable)) as IVsRunningDocumentTable;
runningDocumentTable.AdviseRunningDocTableEvents(this, out var dummyCookie);

4- 别眨眼，魔法来了!实现IVsRunningDocTableEvents.OnBeforeDocumentWindowShow方法如下:

public int OnBeforeDocumentWindowShow(uint docCookie, int fFirstShow, IVsWindowFrame pFrame)
{
    runningDocumentTable.GetDocumentInfo(docCookie,
        out var dummyFlags, out var dummyReadLocks, out var dummyEditLocks,
        out string path, 
        out var dummyHierarchy, out var dummyItemId, out var dummyData);

    IVsWindowFrame windowFrameForTextView;
    var docIsOpenInTextView =
        DocIsOpenInLogicalView(path, VSConstants.LOGVIEWID_Code, out windowFrameForTextView) ||
        DocIsOpenInLogicalView(path, VSConstants.LOGVIEWID_TextView, out windowFrameForTextView);

    //Is the document open in the code/text view,
    //AND the window for that view is the one that has been just activated?

    ActiveDocumentIsText = docIsOpenInTextView && pFrame == logicalViewWindowFrame;

    return VSConstants.S_OK;
}