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

相关推荐

  • (10月14日)凤凰县在重点管控人群中发现1例新冠肺炎阳性感染者(第17例)

    发布于2022-10-14 22:51:39 凤凰县新冠肺炎疫情防控指挥部关于在重点管控人群中发现1例新冠肺炎阳性感染者活动轨迹的通告 2022年10月14日,我县在重点管控人群中发现1例新冠肺炎阳性感染者,目前已转运至定点救治医院。现通告如下: 感染者:黄某某,男,66岁。经初步流调,感染者主要活动轨迹如下: 10月8日 09:22 驾驶摩托车从落潮井镇塘…

    其他 2022年10月15日
    71000
  • 天津市优待目录清单

    序号 现役军人基本优待目录清单 1 为符合悬挂条件的家庭悬挂光荣牌。 2 “八一”、春节为其家庭赠送慰问信。 3 为入伍、退役的军人举行迎送仪式。 4 邀请优秀现役军人代表参加重要庆典和纪念活动。 5 将服役期间荣获个人二等功以上奖励的现役军人名录和事迹载入地方志。 6 为个人立功、获得荣誉称号或勋章的现役军人家庭送喜报。 7 优先聘请优秀现役军人担任大中小…

    其他 2023年2月13日
    3.7K00
  • 曾被判刑或开除公职的机关事业单位人员可以参加企业职工基本养老保险

    2014年10月1日起,《国务院关于机关事业单位工作人员养老保险制度改革的决定》(国发〔2015〕2号)正式实施。 对按照公务员法管理的单位、参照公务员法管理的机关(单位)、事业单位及其编制内的工作人员,实行社会统筹与个人账户相结合的基本养老保险制度。 基本养老保险费由单位和个人共同负担。单位缴纳基本养老保险费(以下简称单位缴费)的比例为本单位工资总额的20…

    其他 2023年6月9日
    89800
  • 安徽安庆:发布首批优待证优待目录清单

      近日,安徽省安庆市退役军人事务局联合相关单位,签订合作协议,细化目录清单,形成了安庆市退役军人和其他优抚对象优待证专属权益目录清单,向社会公布实施。 适用对象   安庆市行政区域内军人军属、退役军人和其他优抚对象,凭相关有效证件(现役军人相关证件以及能证明与现役军人家属关系的证明,退役军人优待证,烈士遗属、因公牺牲军人遗属、病故军人遗属优待证等)享受优待…

    2023年1月27日
    85600
  • (10月6日)凤凰县新冠肺炎疫情防控指挥部关于县城区临时实施全域静默措施的通告(第5例)

    来源:凤凰县新冠肺炎疫情防控指挥部   发布时间:2022-10-06 07:50:02  2022年10月6日,我县在发现4例省外输入新冠肺炎阳性感染者之后,又在县城区全员核酸检测中发现1管混管新冠肺炎阳性。为降低疫情传播风险,减少人员流动,实现早日动态清零,经专家组研判,按照州疫情防控指挥部的部署要求,决定在县城区临时实施全域静默管控…

    其他 2022年10月6日
    47700

发表回复

登录后才能评论