如何通过OfficeJS为PowerPoint操作创建撤销栈条目？

核心问题 #

1. 部分OfficeJS操作无法生成撤销栈，按下CTRL + Z会忽略API做出的更改
2. 无法像旧版COM模型的Application.StartNewUndoEntry那样，将多步操作打包为单个撤销条目

异常场景与重现 #

场景1：删除幻灯片无法撤销 #

创建5张幻灯片，在Script Lab中运行以下代码两次：

PowerPoint.run(async context => {
    const slides = context.presentation.slides
    const slide = slides.getItemAt(0);
    await context.sync();
    slide.delete()
    await context.sync();
})

执行后剩余3张幻灯片，但CTRL + Z无法恢复被删除的幻灯片，操作永久丢失。

场景2：多步操作无法批量撤销 #

对形状执行修改颜色、调整尺寸等多步操作后，CTRL + Z会一次性撤销所有更改，无法实现一次撤销整组操作的需求。

解决方案 #

1. 修复无法撤销的操作问题 #

避免在操作过程中多次调用context.sync()，将所有操作放在同一个PowerPoint.run会话中，并使用UndoManager包裹操作：

PowerPoint.run(async context => {
  // 启动自定义撤销条目
  context.presentation.undoManager.startUndoEntry("删除第一张幻灯片");
  
  const slide = context.presentation.slides.getItemAt(0);
  slide.delete();
  
  await context.sync();
  
  // 结束撤销条目，将操作打包为单个撤销项
  context.presentation.undoManager.endUndoEntry();
}).catch(err => console.error(err));

执行此代码后，CTRL + Z即可恢复被删除的幻灯片。

2. 实现多步操作批量撤销 #

使用UndoManager.startUndoEntry和endUndoEntry包裹多步操作，将其打包为单个撤销条目：

PowerPoint.run(async (context) => {
  // 定义撤销条目标题
  context.presentation.undoManager.startUndoEntry("批量调整形状样式");

  const targetSlide = context.presentation.slides.getItemAt(0);
  const shapes = targetSlide.shapes;
  shapes.load("items");
  await context.sync();

  // 执行多步操作：修改填充色、调整尺寸
  shapes.items.forEach(shape => {
    shape.fill.setSolidColor("#FF5733");
    shape.width = 250;
    shape.height = 150;
  });

  await context.sync();

  // 结束撤销条目，所有操作合并为一个撤销项
  context.presentation.undoManager.endUndoEntry();
}).catch(err => console.error(err));

此时按下CTRL + Z会一次性撤销所有形状的修改操作，符合预期需求。

关键说明 #

• 旧版COM模型的Application.StartNewUndoEntry对应新版API的UndoManager.startUndoEntry + endUndoEntry组合
• 所有需要纳入撤销栈的操作必须放在同一个PowerPoint.run会话中
• 尽量减少不必要的context.sync()调用，避免拆分操作记录

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