简介
在开发 Office 应用时，我们经常需要使用 JavaScript 操作文档、工作表等 Office 对象。而使用 Office.js 官方包时，我们会发现一些固有限制和繁琐重复的操作。为了实现更为高效方便的开发，Microsoft 公司提供了一款名为 @microsoft/office-js-helpers 的 npm 包，它提供了一些 Office.js 常用 API 的二次封装，使得我们可以更方便地访问和修改 Office 对象。本文将为大家介绍 @microsoft/office-js-helpers 的基本使用方法，以及一些常见 API 的使用技巧，希望能帮助大家更好地开发 Office 应用。
安装
使用 npm 安装 @microsoft/office-js-helpers 只需要一条简单的命令：
npm i @microsoft/office-js-helpers
安装成功后，我们可以在项目中导入该包，如下所示：
import * as OfficeHelpers from '@microsoft/office-js-helpers';
使用方法
转换范围
在使用 Office.js 开发 Word、Excel 等文档处理应用时，我们通常需要对 Word.Selection 和 Excel.Range 对象进行操作。但是由于 Office.js APIs 在不同 Office 平台之间的行为有所不同，我们可能需要针对性地对这些对象进行转换。@microsoft/office-js-helpers 提供了一些API来帮助我们快速进行对象的转换。
转换 Word.Selection
要将 Word.Selection 对象转换为简单的字符串，可以使用以下方法：
const activeSelection = WordHelpers.getSelection(); const selectedText = WordHelpers.getSelectedDataAsync(activeSelection);
而如果我们需要将简单的文本字符串添加到 Word 文档中，可以使用以下方法：
const activeSelection = WordHelpers.getSelection(); WordHelpers.insertText(activeSelection, 'Hello world!');
转换 Excel.Range
将 Excel.Range 转换为二维数组时，可以使用以下方法：
const selection = ExcelHelpers.getActiveRange(); const values = ExcelHelpers.getValuesAsync(selection);
而如果需要将二维数组作为数据插入到 Excel.Range 中，则可以使用以下方法：
let range = ExcelHelpers.getActiveRange();
const values = [
['ID', 'Name', 'Age'],
['001', 'Tom', 25],
['002', 'Jerry', 23],
];
ExcelHelpers.setRangeValuesAsync(range, values);消息提示
当我们开发 Office 应用时，有时需要给用户发出一些提示信息。@microsoft/office-js-helpers 提供了一些现成的方法，可以方便地完成这个功能。
显示通知
如果需要显示一个简单的通知框，可以使用以下方法：
OfficeHelpers.UI.notify('操作成功！');显示加载中
在某些场合，我们需要等到数据加载完毕后再运行一些特定的操作，而此时界面应该显示正在加载的状态。可以使用以下方法在界面顶部显示加载中的效果：
OfficeHelpers.UI.showLoadingIndicator();
当数据加载完毕后，我们可以使用以下方法隐藏加载中效果：
OfficeHelpers.UI.hideLoadingIndicator();
快捷键
在 Office 应用中使用快捷键可以帮助用户完成一些常见操作，提高用户的工作效率。@microsoft/office-js-helpers 提供了一些方法来帮助我们自定义快捷键。
例如，下面就是一个使用 @microsoft/office-js-helpers 开发的 Excel 选中行切换的快捷键：
-- -------------------- ---- -------
------------------------------------- -------------- -- -
-- ---- ----- - --- - --------- - --- - --------
-- ------------ -- --------- -- ------- --- --------- -- ------ --- ------------- -
----- ---------- - -----------------------------
-- ----
-- ------- --- ---------- -
------------------------------------------------ ------
-
-- ----
---- -- ------- --- ------------ -
------------------------------------------------ --------
-
-
---当用户按下 Shift + Alt + 上/下箭头时，选中的行将向上/下移动一行。
示例代码
下面是一段使用 @microsoft/office-js-helpers 中一些 API 的示例代码，它在 Word 中创建一个简单的表格，然后添加一些样式：
-- -------------------- ---- -------
-------------- --------- -- -
-- ----
--- ----- - ------------------------------------ -- -------
-- ------
----------- - --------------
-- ---------
--- ----- - ----------------------------
---------------------
----- ---------------
--------------------- - --------- ------- ---------- ---------
--------------------- - -------- ------ ----------- ----------
-- -------
----------------------------------------
----- ---------------
------------------------------- - -------
-- ----
--- ----- - --------------------------
--- ----- - ----------------------------------------------------------------------------------------------- ----------
----------- - ----
-- -----
--------------------------
---小结
通过本文的介绍，我们了解了 @microsoft/office-js-helpers 的基本使用方法，并学会了一些常用 API 的应用技巧。在实际的 Office 应用开发中，@microsoft/office-js-helpers 能够帮助我们提高开发效率，在处理 Office 对象时更为便捷和高效，同时提供了一些便捷的小工具和交互效果，让我们可以更好地与用户进行交流。希望本文可以对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bcc967216659e244786