WPS 加载项开发说明

WPS加载项结构

 WPS加载项由自定义功能区和网页两部分组成。自定义功能区只需要一个配置文件,对应WPS加载项目录中的ribbon.xml文件;网页部分负责执行自定义功能区对应的逻辑功能。因为不需要显示网页,所以省略了HTML文件,并用main.js来引入所有的外部JavaScript文件;这些JavaScript文件中通常包含了一系列用JavaScript实现的函数,这些函数与自定义功能区的功能一一对应,我们称之为接口函数

启动时文件加载过程

WPS 加载项开发说明

WPS在启动时加载index.html,这是WPS加载项的入口文件。index.html从当前路径引入main.js,main.js又引入了js文件夹里面的util.jsribbon.jssystemdemo.js等各种js文件,从而能够在接下来的过程中调用接口函数。当网页成功打开之后,开始解析ribbon.xml生成自定义功能区,解析过程中会调用若干次接口函数,最终完成加载。

程序初始化之后,WPS自定义功能区会生成很多button按钮。其中,点击“弹对话框网页”会生成dialog.html页面,引入dialog.js。点击“弹任务窗格网页”会生成taskpane.html,引入taskpane.js。点击事件在ribbon.js中定义。

注意,开发者应当避免在该目录下创建index.html

WPS加载项API使用

WPS加载项API通过对JavaScript功能进行的扩展,实现了网页与WPS应用程序交互的能力。这些API被集中在window.wps对象下,而我们在开发中通常会省略掉window,直接以wps开始。

开发加载项

在项目目录中,你可以看到一些基本的文件结构,包括imagesjsui等目录,以及index.htmlmain.jsribbon.xml等文件。

编辑这些文件以实现你的功能需求。例如,你可以在index.html中添加HTML代码,在main.js中编写JavaScript逻辑。ribbon.xml用于定义加载项在WPS中的菜单和按钮。

我们在WPS加载项概述里讲了三种交互方式,通过对这些文件的编辑,实现自己的业务逻辑。

自定义功能区:ribbon.xmlribbon.js展示WPS加载项自定义功能区(效率符号)的菜单按钮

对话框:dialog.htmldialog.js展示WPS加载项自定义功能区的“弹对话框网页”按钮

任务窗格:taskpane.htmltaskpane.js展示WPS加载项自定义功能区的“弹任务窗格网页”按钮

WPS 加载项开发说明

调试

WPS加载项调试是对其中的一个网页单独进行的调试。调试时会弹出一个独立调试器对话框,除此之外和网页调试基本一致。可以在调试器的Console中直接查看任意的API属性和调用API方法。调试自动生成的index.html网页,使用快捷键ALT+F12。

注意调试过程中需要先关闭alert或其它同步弹框,才能继续向下调试。

系统集成

用户可以在自己的浏览器中调用WPS加载项的JavaScript方法。 wps_sdk.js对调用进行了封装,让开发者可以快速调用,wps_sdk.js对Chrome、Edge、IE8及IE8以上浏览器进行了支持。

发布部署

加载项开发完成后,很多开发者可能会有这样的一些问题:加载项如何部署呢、用户如何访问部署后的加载项呢、用户需要安装什么、用户是否需要去手动修改配置呢?

目前我们提供两种部署方式,jsplugins.xml模式publish.xml模式,两种都不需要用户去手动配置什么,只需要本地安装好相应版本的WPS就行。

(0)
上一篇 2024年11月12日 下午7:53
下一篇 2024年11月13日 上午10:37

相关推荐

  • 麒麟系统安全机制

    解决问题:kylin麒麟系统中如若出现root用户登录下,也执行不了可执行文件,文件权限有可执行权限,但是报权限不足,可以看看这边文章,需要修改KYSEC,对应第三部分。 麒麟系统为什么称为国内最安全的Linux系统?秘密就在于KYSEC,麒麟系统安全机制。一般情况下Linux下默认的接入控制是DAC,其特点是资源的拥有者可以对他进行任何操作(读、写、执行)…

    2022年11月30日
    3.0K00
  • (10月6日)致留居凤凰的游客朋友

    亲爱的游客朋友: 非常感谢您在国庆期间来到神秘湘西、天下凤凰旅游。10月3日以来,您穿着夏衣来到凤凰,却因新冠肺炎疫情,凤凰城紧急启动临时全域静默措施而耽误了既定行程,给您带来诸多不便,我们深表歉意。 我们感同身受您的焦虑,理解您归家的心情,但我们必须清醒地认识到,在没有确认您自身安全的情况下,归家后的相聚可能带来疫情传播,我们诚恳地向您建议,把风险留下来,…

    2022年10月7日
    63900
  • 从2021年财报看华为现状

    财务数据 2021财年 2020财年 总收入 6368.07 8913.68 成本 3293.65 5642.36 毛利 3074.42 3271.32 经营费用总额 2468.27 2553.23 其中:研发费用 1426.66 1418.93 其中:销售、管理及行政费用 1041.61 1134.3 营业利润 1214.12 725.01 税前利润 12…

    2022年9月27日
    3.8K00
  • Linux系统下批量生成不同大小的文件

    在Linux系统下,批量生成不同大小的文件可以使用多种方法,其中最常用的是dd命令。dd是一个强大的工具,用于无格式化地复制文件,通常用于磁盘镜像或者创建特定大小的文件。下面是如何使用dd命令来生成一系列具有不同大小的文件: 假设你需要生成一系列从1MB到10MB的文件,每个文件增加1MB,你可以使用下面的shell脚本来实现: 在这个脚本中: /dev/z…

    其他 2024年6月19日
    1.0K00
  • 凤凰县严格落实入凤“先报、即查、即检、即管”措施

    当前,全国疫情呈现点多、面广、频发特点,形势依然严峻复杂,“外防输入”压力持续增大。为进一步做好当前疫情防控“外防输入”工作,根据国务院联防联控机制优化防控工作“二十条”措施等有关要求,凤凰县严格落实入凤“先报、即查、即检、即管”措施。 1.入凤先报备 所有外省或省内发生本土疫情且外溢风险高的市州来(返)凤人员抵凤前,应至少提前1天电话向目的地所在村(社区)…

    其他 2022年11月23日
    84600

发表回复

登录后才能评论