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

相关推荐

  • Excel 中的 VLOOKUP 和 INDEX-MATCH 示例

    推荐使用index+match组合函数来查找数据。 也可以尝试老办法vlookup函数,不过这个函数需要注意的地方太多了,容易出错,不推荐新手使用。 VLOOKUP 示例:我们在 Item ID 列中查找文本“a_003”,并希望从 Price 列返回相应的值29.30。 = VLOOKUP ( lookup_value , table_array , co…

    2022年8月23日
    1.4K00
  • 企业职工基本养老保险病残津贴暂行办法

    人力资源社会保障部 财政部 关于印发《企业职工基本养老保险病残津贴暂行办法》的通知 人社部发〔2024〕72号 各省、自治区、直辖市及新疆生产建设兵团人力资源社会保障厅(局)、财政厅(局):         为保障企业职工基本养老保险参保人员的合法权益,按照党中央、国务院改革和完善养老保险制度的部署和社会保险法要求,我…

    其他 2024年10月21日
    55100
  • 会议座次怎么安排?看这里。

    一个原则:先确定1号位,然后左右依次排开。 注意偶数的情况,1号位只有摆到中间靠右,才能不打破这个原则。

    2022年8月1日
    1.5K00
  • Word批量生成各种通知证明,喝杯茶就能完成所有工作

    人多、事多、麻烦多,时间不够用怎么办?晚上要约会,不能按时下班怎么办?先发两句牢骚,然后接着干。你干死干活,中午晚上加班。我泡茶喝水,上午下午聊天。 如果你需要给200个人出具书面通知,你准备一份一份复制粘贴吗?如果你需要打印200份座次姓名牌,你准备一个名字一个名字打印吗?如果你需要生成10套试卷,你准备从题库里面一个题目一个题目筛选出来吗?同志们,遇到重…

    2022年8月5日
    1.8K00
  • 200万湖南文旅消费券来了!游客可上携程APP免费领取

    7月19日,“首届湖南旅游发展大会惠民助企文化消费券活动”携程平台首发仪式正式启动。全国游客均可通过携程APP参与消费优惠券补贴活动,活动覆盖湖南全省范围内A级景区、星级酒店、旅游线路等产品。活动持续到9月30日,消费券补贴金额达到200万元。 本次文旅消费券分为“酒店消费券”“门票消费券”及“度假产品消费券”三类券种,可以用于所有湖南文旅消费券活动的旅游产…

    2022年7月20日
    67400

发表回复

登录后才能评论