使用异步执行上下文为 Office.js Javascript Word 加载项添加子例程

Question

我在为 Word 开发 Office.js 插件方面取得了很大成功。插件的常见任务之一是搜索和替换，需要插件中的多个操作按钮使用。因此，我想创建一个将搜索和替换任务分开的函数，这样我就可以避免错误并使代码更加模块化。我一直在尝试使用 Office.js 异步执行模型来执行此操作。

此代码有效（作为 React 类的方法）：

    replaceX() {
    console.log("replaceX");
    window.Word.run(async (context: any) => {

        const range = context.document.getSelection();

        await context.sync();
        var query = "X";
        var replacement = "gabagool";

        var results = range.search(query);
        results.load();               

        await context.sync();

        for (var i=0; i<results.items.length; i++) {
            results.items[i].insertText(replacement,'Replace');
        }

        await context.sync();
    });
}

但是这段代码失败了：

    replaceX() {
    console.log("replaceX");
    window.Word.run(async (context: any) => {

        const range = context.document.getSelection();

        await context.sync();
        var query = "X";
        var replacement = "gabagool";

        this.replaceInRange(context, range, query, replacement, {});

        await context.sync();
    });
}

async replaceInRange(context:any, range:any, query:String, replacement:String, searchOptions:any) {
    console.log('replaceInRange');
    var results = range.search(query, searchOptions);
    results.load();
    await context.sync();

    for (var i=0; i<results.items.length; i++) {
        results.items[i].insertText(replacement,'Replace');
    }

}

我尝试了一些变体，但我确定我缺少一些基本的东西。谁能帮我找出正确的方法来处理需要访问父函数上下文的子例程？

Answer 1

您的代码破坏了 Promise 链。您的replaceInRange 方法在其中有一个对context.sync 的异步调用，但replaceInRange 本身并没有等待，因此一旦它开始执行，执行引擎就会转到replaceInRange 调用下方的行，这是另一个context.sync。但最后一个context.sync 将完成，然后Word.run 将在字符串替换代码运行之前完成。

尝试在调用 replaceInRange 之前添加一个 await 关键字，如下所示：

await this.replaceInRange(context, range, query, replacement, {});

我注意到的其他几件事：

1. 不需要Word.run 中的第一个context.sync。

2. 您没有将任何参数传递给load() 方法。执行此操作时，将加载所有标量属性。这是不必要的性能损失。您只需加载text 属性即可执行insertText。使用results.load('text');

3. Word.run 本身是异步的，所以你应该在调用它时使用await 关键字。您可以在没有await 的情况下逃脱，因为您的父方法在 Word.run 执行后什么都不调用，但是如果您修改了该方法以便在Word.run 之后调用更多的东西，那么更多的东西会在 @ 之前开始执行如果您不等待Word.run，则 987654342@ 已完成。

有一本关于 Office 加载项的好书，其中包含有关这些主题的大量信息，包括 Promise 链：Building Office Add-ins。它花费了一些东西，但它是值得的。在你问之前，这不是我的书，我没有从它的销售中获得任何收益。