VSTO Word加载项：寻找文档完全加载并显示后触发的事件

在开发VSTO Word加载项时，需要在从模板/空白创建的新文档完全加载并显示给用户后执行两个操作：调整页眉页脚，以及调用Application.CommandBars.ExecuteMso("DocumentInformationShowHide")显示文档信息。但测试发现DocumentChange和NewDocument事件触发过早，此时文档尚未完成UI渲染，执行操作会导致Word死锁。

方案1：使用WindowActivate事件（推荐） #

当Word窗口激活时，文档已经完成加载并显示，此时执行操作不会阻塞UI线程。需要添加文档标识过滤，避免重复处理同一文档。

实现代码 #

private readonly HashSet<string> _processedDocuments = new HashSet<string>();

private void ThisAddIn_Startup(object sender, EventArgs e)
{
    // 订阅窗口激活事件
    Application.WindowActivate += Application_WindowActivate;
}

private void Application_WindowActivate(Word.Document doc, Word.Window window)
{
    // 跳过已处理的文档
    if (_processedDocuments.Contains(doc.FullName))
        return;

    // 判断是否为新建文档（从模板/空白创建，未保存过）
    if (doc.Type == Word.WdDocumentType.wdTypeDocument && string.IsNullOrEmpty(doc.Path))
    {
        try
        {
            // 执行页眉页脚操作
            ManipulateHeaderAndFooter(doc);
            // 触发文档信息面板显示
            Application.CommandBars.ExecuteMso("DocumentInformationShowHide");
            
            // 记录已处理的文档（未保存时FullName为空，后续保存后更新）
            _processedDocuments.Add(doc.FullName);
        }
        catch (Exception ex)
        {
            _logger.Error($"处理新建文档出错：{ex.Message}");
        }
    }

    // 文档保存后更新处理记录
    doc.BeforeSave += (s, args) =>
    {
        if (_processedDocuments.Contains(string.Empty))
        {
            _processedDocuments.Remove(string.Empty);
            _processedDocuments.Add(doc.FullName);
        }
    };
}

// 你的页眉页脚处理方法（传入当前文档）
private void ManipulateHeaderAndFooter(Word.Document doc)
{
    // 这里实现你的页眉页脚调整逻辑
    var header = doc.Sections[1].Headers[Word.WdHeaderFooterIndex.wdHeaderFooterPrimary];
    // ... 具体操作
}

逻辑说明 #

• WindowActivate在文档窗口完全显示后触发，避免了初始化阶段的UI阻塞。
• 通过doc.Path == string.Empty判断是否为未保存的新建文档，过滤掉打开已有文档的场景。
• 用HashSet记录已处理的文档，防止重复执行操作。

方案2：结合Document.Activate与异步延迟 #

如果方案1不适用，可以通过订阅文档激活事件，配合短延迟等待文档渲染完成，再执行操作。注意必须切换回Word的STA线程执行Office对象操作。

实现代码 #

private void ThisAddIn_Startup(object sender, EventArgs e)
{
    // 订阅新建文档和打开文档事件
    Application.NewDocument += Application_NewDocument;
    Application.DocumentOpen += Application_DocumentOpen;
}

private void Application_NewDocument(Word.Document doc)
{
    SubscribeToDocumentActivate(doc);
}

private void Application_DocumentOpen(Word.Document doc)
{
    SubscribeToDocumentActivate(doc);
}

private void SubscribeToDocumentActivate(Word.Document doc)
{
    doc.Activate += Doc_Activate;
}

private async void Doc_Activate()
{
    var currentDoc = Application.ActiveDocument;
    if (currentDoc == null) return;

    // 等待文档完成UI渲染（延迟时间可根据实际情况调整）
    await Task.Delay(500);

    // 切换回Word主线程执行操作（VSTO必须在STA线程中操作Office对象）
    await Task.Factory.StartNew(() =>
    {
        ManipulateHeaderAndFooter(currentDoc);
        Application.CommandBars.ExecuteMso("DocumentInformationShowHide");
    }, System.Threading.CancellationToken.None, TaskCreationOptions.None, System.Threading.SynchronizationContext.Current);

    // 取消订阅，避免重复触发
    currentDoc.Activate -= Doc_Activate;
}

注意事项 #

• 延迟时间需要根据实际环境调整，过短可能仍会触发死锁，过长影响用户体验。
• 必须使用SynchronizationContext.Current确保操作在Word的STA线程执行，否则会抛出跨线程操作异常。

为什么DocumentChange/NewDocument会导致死锁？ #

这两个事件在文档初始化阶段触发，此时Word正在加载文档资源、构建UI，处于线程阻塞状态。调用ExecuteMso会尝试触发UI操作，导致线程互相等待，最终引发死锁。

内容的提问来源于stack exchange，提问作者Eliah Thommen