VSTO Word插件中SharePoint/OneDrive文档保存后事件处理问题

针对云端路径（SharePoint/OneDrive）的保存场景，BackgroundSavingStatus确实不会生效——这个属性仅针对本地磁盘的后台保存操作。你可以通过以下几种方式来等待云端保存/同步完成：

方法1：利用Document.Sync对象轮询同步状态 #

Word针对云端文档提供了Sync对象，可通过它的Status属性判断同步状态：

// 假设doc是当前操作的Word.Document对象
if (doc.Sync != null)
{
    // 等待同步完成，同时设置超时避免死循环
    int timeoutSeconds = 30;
    DateTime startTime = DateTime.Now;
    
    while (doc.Sync.Status != Word.WdSyncStatus.wdSyncStatusIdle)
    {
        // 避免线程阻塞UI，添加短暂延迟
        System.Threading.Thread.Sleep(100);
        
        // 超时退出
        if ((DateTime.Now - startTime).TotalSeconds > timeoutSeconds)
        {
            throw new TimeoutException("云端保存同步超时");
        }
        
        // 强制刷新Sync状态（可选，确保状态更新）
        doc.Sync.Refresh();
    }
}

WdSyncStatus的关键枚举值：

• wdSyncStatusIdle：同步已完成，处于空闲状态
• wdSyncStatusSyncing：正在同步中
• wdSyncStatusPendingChanges：有未同步的更改

方法2：监听Document.SyncEvent事件 #

如果轮询不符合你的需求，可以通过注册SyncEvent事件来监听同步完成：

// 在文档打开或初始化时注册事件
doc.Sync.SyncEvent += Sync_SyncEvent;

// 事件处理方法
private void Sync_SyncEvent(Word.Sync SyncObject, Word.MsoSyncEventType SyncEventType)
{
    if (SyncEventType == Word.MsoSyncEventType.msoSyncEventTypeSucceeded)
    {
        // 同步完成，执行你的字典更新逻辑
        UpdateDocumentInfoDictionary(doc.FullName);
        
        // 记得注销事件，避免内存泄漏
        SyncObject.SyncEvent -= Sync_SyncEvent;
    }
    else if (SyncEventType == Word.MsoSyncEventType.msoSyncEventTypeFailed)
    {
        // 处理同步失败的情况
        Debug.WriteLine("云端同步失败：" + SyncObject.ErrorMessage);
        SyncObject.SyncEvent -= Sync_SyncEvent;
    }
}

方法3：结合Saved属性与延迟检查 #

如果上述Sync对象不可用（比如旧版本Word），可以通过轮询Document.Saved属性，但需要注意添加延迟并处理文档关闭的情况：

int retryCount = 0;
const int maxRetries = 30; // 最多重试30次，每次间隔100ms

while (!doc.Saved && retryCount < maxRetries)
{
    System.Threading.Thread.Sleep(100);
    retryCount++;
    
    // 检查文档是否已被关闭，避免访问已释放的COM对象
    if (doc.Application.Documents.Cast<Word.Document>().All(d => d.FullName != doc.FullName))
    {
        throw new InvalidOperationException("文档已关闭，无法完成保存检查");
    }
}

if (!doc.Saved)
{
    throw new Exception("文档保存未完成");
}

注意事项 #

• 所有涉及Word COM对象的操作，要确保在UI线程执行（VSTO插件默认在UI线程，但如果用了后台线程，需要用this.Application.Invoke切换）
• 记得在操作完成后释放COM对象，避免内存泄漏
• 云端同步可能受网络影响，一定要添加超时或重试机制，避免无限等待

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