如何在Excel JS中列出工作簿/工作表的批注及对应单元格地址

核心逻辑 #

Excel JS API里，工作表（Worksheet）对象的comments属性对应该表的所有批注集合，通过加载并遍历这个集合，就能获取每个批注的内容、对应单元格地址等信息。针对整个工作簿的需求，只需遍历所有工作表重复上述操作即可。

1. 获取指定工作表的所有批注及单元格地址 #

直接定位目标工作表，加载批注的关键属性后同步遍历处理：

async function fetchSheetComments(targetSheetName) {
  await Excel.run(async (context) => {
    // 获取目标工作表
    const sheet = context.workbook.worksheets.getItem(targetSheetName);
    // 获取工作表内所有批注
    const commentsCollection = sheet.comments;
    // 加载需要的批注属性（可按需添加author、id等字段）
    commentsCollection.load("items(content, parentAddress)");
    
    await context.sync();
    
    // 遍历处理每个批注，这里可结合内容添加回复
    commentsCollection.items.forEach(comment => {
      console.log(`单元格：${comment.parentAddress} | 批注内容：${comment.content}`);
      // 示例：给包含特定关键词的批注加回复
      // if (comment.content.includes("待处理")) {
      //   comment.replies.add("已安排处理");
      // }
    });
    
    // 若添加了回复，需再次同步提交更改
    await context.sync();
  });
}

2. 获取整个工作簿的所有批注 #

遍历工作簿内的所有工作表，逐个获取批注集合：

async function fetchWorkbookComments() {
  await Excel.run(async (context) => {
    const allSheets = context.workbook.worksheets;
    // 先加载所有工作表名称
    allSheets.load("items(name)");
    await context.sync();
    
    // 遍历每个工作表获取批注
    for (const sheet of allSheets.items) {
      const commentsCollection = sheet.comments;
      commentsCollection.load("items(content, parentAddress)");
      await context.sync();
      
      console.log(`===== 工作表：${sheet.name} =====`);
      commentsCollection.items.forEach(comment => {
        console.log(`单元格：${comment.parentAddress} | 批注内容：${comment.content}`);
      });
    }
  });
}

关键注意事项 #

• 区分批注与注释：Excel旧版的“注释”对应API中的worksheet.notes对象，获取逻辑类似，需加载items(text, cellAddress)属性。
• 性能优化：若工作簿工作表数量多，可尝试批量加载属性减少context.sync()调用次数，降低通信开销。
• 权限配置：确保插件manifest文件中配置了足够的权限范围（如ReadWriteDocument），避免访问被拒绝。

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