如何判断活动文档是否为文本文档？

Question

我正在开发一个 Visual Studio 扩展，其中只有当活动文档是文本文档（例如 Visual Studio 的 "Toggle Bookmark" 确实如此）。问题是我不知道如何判断什么时候是这种情况。

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

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) 当文档同时具有代码视图和设计视图（例如 .visxmanifest 文件）时，这会产生误报) 在设计模式下打开。

我也尝试过使用 IVsTextManager.GetActiveView，但这会返回打开的 last 活动文本视图 - 所以如果我打开一个 .txt 文件，然后.png 文件，它 returns .txt 文件的数据，即使它不再是活动文档。

那么，如何检查活动文档是文本文档，还是可以具有设计器的文档的代码视图...如果可能，不使用 "undocumented" classes/members?

更新： 我找到了一个稍微好一点的解决方案。在 window 激活的处理程序中：

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

至少this one is properly documented，但我还是和设计师有误报的问题

Answer 1

我终于明白了。这有点棘手，但它有效并且是 100% "legal"。这是食谱：

1- 使包 class 实现 IVsRunningDocTableEvents。使所有方法只是 return VSConstants.S_OK;

2-在包中添加如下字段和以下辅助方法class:

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-在包class的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;
}

如何判断活动文档是否为文本文档？

How to tell if the active document is a text document?

visual-studio

vsix

visual-studio-extensions