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

相关推荐

  • 3岁以下婴幼儿健康养育照护指南(试行)

    3岁以下婴幼儿健康养育照护指南(试行) 为贯彻落实《中共中央 国务院关于优化生育政策促进人口长期均衡发展的决定》、《国务院办公厅关于促进3岁以下婴幼儿照护服务发展的指导意见》(国办发〔2019〕15号)和《健康儿童行动提升计划(2021—2025年)》(国卫妇幼发〔2021〕33号),提升儿童健康水平,促进儿童早期发展,加强婴幼儿养育照护指导,强化…

    2022年11月30日
    77800
  • 国产操作系统常用的命令式小工具

    常用命令 查看电脑软硬件配置:hardinfo 系统截图(可以延迟抓取截图):mate-screenshot –interactive 计算器:mate-calc 字体安装管理器:font-manager 搜索文件:mate-search-tool 屏幕键盘:onboard 网络工具:gnome-nettool 在哪里?如何输入命令? 1、电脑桌…

    2024年9月22日
    98500
  • 关于进一步加强城镇职工基本医疗保险有关工作的通知

    各市州、县市区人力资源和社会保障局、财政局: 我省城镇职工基本医疗保险制度实施以来,制度建设逐步完善,参保人员基本医疗需求得到较好保障,为促进全省经济和社会发展发挥了重要作用。但近年来部分统筹地区出现了基金当期收不抵支甚至累计亏损的情形,危及到制度的可持续性。为规范城镇职工基本医疗保险管理,确保基金收支平衡、制度平稳运行和可持续发展,现就进一步加强城镇职工基…

    其他 2024年10月8日
    46000
  • 湘西州新冠肺炎疫情防控指挥部关于居民健康码解码工作的温馨提示

    2022-10-14 10:16 · 来自湖南 · 红网 近期,因新冠肺炎疫情防控工作需要,湘西州部分县市对所辖区内的部分居民按照不同风险等级实施了健康码赋码。截至10月13日,已有部分居民达到解码要求但没有得到及时解码。为了帮助居民做好安全、科学、精准解码工作,恢复正常的生产生活,州、县市两级新冠肺炎疫情防控指挥部已成立健康码管理协调服务工作专班,开展对符…

    2022年10月14日
    84400
  • (10月8日)凤凰县新增1例新冠病毒核酸检测阳性感染者(第8例)

    凤凰县新冠肺炎疫情防控指挥部关于新增1例新冠病毒核酸检测阳性感染者活动轨迹的通告 2022年10月7日0-24时,我县新增1例新冠病毒核酸检测阳性感染者,目前已转运至定点救治医院。现将活动轨迹通告如下: 王某,女,40岁,凤凰县溪桥夜语江景民宿前台,现居住于凤凰县城北天下游公寓,系10月7日通报的感染者杨某密切接触者。 10月1日 09:38 &n…

    其他 2022年10月11日
    54700

发表回复

登录后才能评论