ms-word - 如何在不同的 Word.run 上下文中使用范围？

Question

我为 word 创建了一个任务 Pane 插件，它运行搜索并将有关结果的信息作为列表显示给用户。
当用户单击列表中的某个项目时，我想选择 word 中的范围以向用户显示该项目的位置。
然后插件将允许用户在该范围内执行其他任务，例如更改字体颜色。

我可以使用以下函数运行搜索并获取显示范围:

function runSearch(textToFind) {
  var items = [];
  return Word.run(function(context) {
    var options = Word.SearchOptions.newObject(context);
    options.matchWildCards = false;

    var rangesFind = context.document.body.search(textToFind, options);
    context.load(rangesFind, 'text, font, style');
    return context.sync().then(function() {
      for (var i = 0; i < rangesFind.items.length; i++) {
        items.push(rangesFind.items[i]);
        context.trackedObjects.add(rangesFind.items[i]);
      }
      return context.sync();
    });
  })
  .then(function() {
    return items;
  });
}; 

但是我很难选择用户点击的范围。
我尝试使用范围上下文:

function selectRange(range){
  range.select();
  return range.context.sync();
}

或者在新的 Word.run 上下文中使用范围:

function selectRange(range){
  return Word.run(function(context) {
    context.load(range);
    return context.sync().then(function(){
      range.select();
      return context.sync();
    });
  });
}

我遇到了一种潜在的方法，它为每个搜索结果创建一个内容控件，然后重新加载 selectRange 中的所有内容控件。在新的上下文中运行并找到匹配的控件，但是当我已经有了范围时，这似乎非常低效。

在不同的 Word.run 上下文中重用范围的最佳方法是什么？

Answer 1

您不能跨 Word.run 使用对象调用。 Word.run每次调用它时都会创建一个新的上下文，而原始对象则绑定(bind)到它自己的上下文，从而造成不匹配。

话虽如此，您绝对可以，从 Word.run ，将您想要的对象添加到context.trackedObjects.add(obj) ，并且即使在 Word.run 完成执行后，它们仍将作为工作对象。通过“工作对象”，我的意思是它们的路径不会失效(想想类似于垃圾收集的东西，但对于远程对象)。

一旦你有了这样的对象(它看起来像你一样)，你应该能够调用

range.select();
range.context.sync().catch(...);

如果它不适合你，你能提供一个你遇到的错误的例子吗？

为了完整起见，我应该注意，一旦将对象添加到 trackedObjects 集合中，您实际上就是将这些对象的内存管理掌握在自己手中。这意味着，如果您没有正确释放内存，您将通过阻碍 Word 的内存/范围调整链来减慢 Word。因此，一旦您使用完跟踪的对象，您应该调用 obj.context.trackedObjects.remove(obj) ，后跟 obj.context.sync() .不要忘记最后一部分 - 如果您不进行同步，您删除跟踪对象的请求将不会被调度，并且您将继续使用内存。

======= 更新 1 =======

汤姆，感谢您提供错误消息。看起来这可能是 API 的 Word 实现中的一个错误——我会跟进，如果有更多问题，有人可能会与您联系。

从概念的角度来看，您绝对走在正确的道路上——以下在 Excel 中确实有效，例如:

var range;
Excel.run(function (ctx) {
    var sheet = ctx.workbook.worksheets.getActiveWorksheet();

    range = sheet.getRange("A5");
    range.values = [[5]];
    ctx.trackedObjects.add(range);

    return ctx.sync();
})
.then(function(){
    setTimeout(function() {
        range.select();
        range.context.trackedObjects.remove(range);
        range.context.sync();
    }, 2000);
})
.catch(function (error) {
    showMessage("Error: " + error);        
});

======= 更新 2 =======

事实证明，产品中确实存在错误。然而，好消息是只用 JavaScript 修复很容易，事实上我们将在接下来的几周内更新 CDN。

修复后，以下代码有效:

var paragraph;
Word.run(function (ctx) {
    var p = ctx.document.body.paragraphs.first;
    paragraph = p.next;
    ctx.trackedObjects.add(paragraph);
    return ctx.sync();
})
.then(function(){
    setTimeout(function() {
        paragraph.select();
        paragraph.context.trackedObjects.remove(paragraph);
        paragraph.context.sync()
            .then(function() {
                console.log("Done");
            })
            .catch(handleError);
    }, 2000);
})
.catch(handleError);

function handleError (error) {
    console.log('Error: ' + JSON.stringify(error));
    if (error instanceof OfficeExtension.Error) {
        console.log('Debug info: ' + JSON.stringify(error.debugInfo));
    }
}

想要更好的消息吗？在 CDN 更新之前，您可以使用下面的代码来“修补”JavaScript 库并让上面的代码运行。您应该在 Office.js 已经加载(即在您的 Office.initialize 函数中)一段时间后运行此代码，然后再执行 Word.run .

var TrackedObjects = (function () {
    function TrackedObjects(context) {
        this._autoCleanupList = {};
        this.m_context = context;
    }
    TrackedObjects.prototype.add = function (param) {
        var _this = this;
        if (Array.isArray(param)) {
            param.forEach(function (item) { return _this._addCommon(item, true); });
        }
        else {
            this._addCommon(param, true);
        }
    };
    TrackedObjects.prototype._autoAdd = function (object) {
        this._addCommon(object, false);
        this._autoCleanupList[object._objectPath.objectPathInfo.Id] = object;
    };
    TrackedObjects.prototype._addCommon = function (object, isExplicitlyAdded) {
        if (object[OfficeExtension.Constants.isTracked]) {
            if (isExplicitlyAdded && this.m_context._autoCleanup) {
                delete this._autoCleanupList[object._objectPath.objectPathInfo.Id];
            }
            return;
        }
        var referenceId = object[OfficeExtension.Constants.referenceId];
        if (OfficeExtension.Utility.isNullOrEmptyString(referenceId) && object._KeepReference) {
            object._KeepReference();
            OfficeExtension.ActionFactory.createInstantiateAction(this.m_context, object);
            if (isExplicitlyAdded && this.m_context._autoCleanup) {
                delete this._autoCleanupList[object._objectPath.objectPathInfo.Id];
            }
            object[OfficeExtension.Constants.isTracked] = true;
        }
    };
    TrackedObjects.prototype.remove = function (param) {
        var _this = this;
        if (Array.isArray(param)) {
            param.forEach(function (item) { return _this._removeCommon(item); });
        }
        else {
            this._removeCommon(param);
        }
    };
    TrackedObjects.prototype._removeCommon = function (object) {
        var referenceId = object[OfficeExtension.Constants.referenceId];
        if (!OfficeExtension.Utility.isNullOrEmptyString(referenceId)) {
            var rootObject = this.m_context._rootObject;
            if (rootObject._RemoveReference) {
                rootObject._RemoveReference(referenceId);
            }
            delete object[OfficeExtension.Constants.isTracked];
        }
    };
    TrackedObjects.prototype._retrieveAndClearAutoCleanupList = function () {
        var list = this._autoCleanupList;
        this._autoCleanupList = {};
        return list;
    };
    return TrackedObjects;
}());
OfficeExtension.TrackedObjects = TrackedObjects;

希望这可以帮助!

~ Michael Zlatkovsky，Office 可扩展性团队的开发人员，MSFT