Excel Desktop中Office.context.document.settings.get()失效，设置无法持久化

关键修复步骤 #

• 必须调用saveAsync()完成持久化：set()仅将值写入内存中的settings对象，并未保存到文档。执行以下代码才能确保设置被持久化：

  // 设置键值对
  Office.context.document.settings.set('user_preference', 'dark_mode');
  // 保存到文档
  Office.context.document.settings.saveAsync(result => {
    if (result.status === Office.AsyncResultStatus.Succeeded) {
      console.log('设置已成功保存');
    } else {
      console.error('保存失败:', result.error.message);
    }
  });
  

• 读取前确保settings已加载：Excel启动后，需等待settings从文档加载完成再读取。可通过refreshAsync()强制刷新，或在Office.initialize事件中处理：

  Office.initialize = reason => {
    // 刷新settings以获取最新数据
    Office.context.document.settings.refreshAsync(() => {
      const savedValue = Office.context.document.settings.get('user_preference');
      console.log('读取到的设置:', savedValue);
    });
  };
  

• 匹配Office.js版本与Excel版本：你的Excel 2016版本（16.0.4266.1001）属于旧分支，需使用兼容的Office.js版本。建议引入v1.1版本的CDN：

  <script src="https://appsforoffice.microsoft.com/lib/1/hosted/office.js"></script>
  

• 确认文档格式支持：仅.xlsx、.xlsm等Open XML格式支持插件设置持久化，.xls老旧格式不兼容，确保文件格式正确。

额外验证项 #

• 测试基础键值：先用无特殊字符的简单键（如test_key）和基础类型值（字符串、数字）测试，排除键名或值类型问题。
• 检查插件权限：在manifest.xml中确认权限配置为ReadWriteDocument，确保插件有读写文档设置的权限：

  <Permissions>ReadWriteDocument</Permissions>
  

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