C# VSIX 定期将状态消息写入输出窗口

问题描述

我正在开始使用 Visual Studio 扩展，并希望在任务的某些里程碑期间将状态消息写入输出窗口，以报告其进度。

我正在使用命令从上下文菜单中触发任务。这是它的 Execute 方法的模拟示例：

private void Execute(object sender,EventArgs e)
{
    ThreadHelper.ThrowIfNotOnUIThread();

    var paneGuid = Guid.NewGuid();

    var outputwindow = (IVsOutputwindow)Package.GetGlobalService(typeof(SVsOutputwindow));
    outputwindow.CreatePane(ref paneGuid,"My Window",1,1);
    outputwindow.GetPane(ref paneGuid,out var outputPane);

    outputPane.Activate();

    outputPane.OutputString("Starting...\n");

    Thread.Sleep(2000);

    outputPane.OutputString("1...\n");

    Thread.Sleep(2000);

    outputPane.OutputString("2...\n");

    Thread.Sleep(2000);

    outputPane.OutputString("3...\n");

    Thread.Sleep(2000);

    outputPane.OutputString("Finished");
}

不是按写入的方式显示输出，而是在 Execute 方法完成后显示输出窗口。

如何让它立即显示并定期写入消息？

更新：解决方案

正如 JHBonarius 在下面所建议的，解决方案是将逻辑移到异步任务中，并根据需要调用 UI 线程写入输出窗口：

private void Execute(object sender,EventArgs e)
{
    ThreadHelper.JoinableTaskFactory.RunAsync(async () =>
    {
        var paneGuid = Guid.NewGuid();

        await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
        var outputwindow = (IVsOutputwindow)Package.GetGlobalService(typeof(SVsOutputwindow));
        outputwindow.CreatePane(ref paneGuid,1);
        outputwindow.GetPane(ref paneGuid,out var outputPane);
        outputPane.Activate();

        outputPane.OutputString("Starting...\n");
        await TaskScheduler.Default;

        // Call to some async task
        await Task.Delay(2000);

        await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
        outputPane.OutputString("1...\n");
        await TaskScheduler.Default;

        // Call to some async task
        await Task.Delay(2000);

        await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
        outputPane.OutputString("2...\n");
        await TaskScheduler.Default;

        // Call to some async task
        await Task.Delay(2000);

        await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
        outputPane.OutputString("3...\n");
        await TaskScheduler.Default;

        // Call to some async task
        await Task.Delay(2000);

        await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync();
        outputPane.OutputString("Finished");
        await TaskScheduler.Default;
    });
}

谢谢， 杰

解决方法

您在 UI 线程上并且不返回控制权（而是通过睡眠锁定线程）。因此 UI 无法呈现。您可能希望将其重写为单独的方法或异步方法。