| WPS 开发人员参考 |
| WPS 加载项开发说明 |
WPS 加载项结构
WPS 加载项由自定义功能区和网页两部分组成。自定义功能区只需要一个配置文件,对应 WPS 加载项目录中的ribbon.xml文件; 网页部分负责执行自定义功能区对应的逻辑功能。因为不需要显示网页,所以省略了 HTML 文件,并用main.js来引入所有的外部 JavaScript 文件; 在这些 JavaScript 文件中通常包含了一系列用 JavaScript 实现的函数,这些函数与自定义功能区的功能一一对应,我们称之为接口函数。
启动流程
WPS 加载项启动时,首先在 WPS 加载项对应文件夹中自动创建index.html网页并打开,index.html从当前路径引入main.js,从而能够在接下来的过程中执行接口函数。 当网页打开成功之后,开始解析ribbon.xml生成自定义功能区,解析过程中会调用若干次接口函数,最终完成加载。注意,开发者应当避免在该目录下创建index.html。
WPS 加载项 API 使用
WPS 加载项 API 通过对 JavaScript 功能进行的扩展,实现了网页与 WPS 应用程序交互的能力。这些 API 被集中在window.wps对象下,而我们在开发中通常会省略掉window,直接以wps开始。
调试
WPS 加载项调试是对其中的一个网页单独进行的调试。调试时会弹出一个独立调试器对话框,除此之外和网页调试基本一致。 可以在调试器的 Console 中直接查看任意的 API 属性和调用 API 方法。调试自动生成的index.html网页,使用快捷键 ALT + F12。 注意调试过程中需要先关闭alert或其它同步弹框,才能继续向下调试。
系统集成
用户可以在自己的浏览器中调用 WPS 加载项的 JavaScript 方法。wpsstartup.js对调用进行了封装,让开发者可以快速调用, wpsstartup.js对Chrome、Edge、IE8及IE8以上浏览器进行了支持。其它方式的集成请参考wpsstartup.js实现。 点击这里试一下吧。
| 示例代码 |
|---|
|
接口定义
WpsStartUp.StartUp(type, name, func, params, callBack)
参数
其中 WpsStartUp 是wpsstartup.js封装的对象,StartUp是启动 WPS 应用程序的接口。
说明
启动 WPS 应用程序需要用户在浏览器点击允许启动 WPS Office。WpsStartUp.StartUp执行是异步的,调用后立刻返回。 等到WpsStartUp.StartUp执行完成后,执行callBack回调函数,并给回调函数传参
{
status: 0, //返回状态。0 代表成功;1 代表上次请求没有完成;2 代表没有允许执行。
message: "" //返回状态描述信息
}