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

相关推荐

  • 国务院关于深入实施“人工智能+”行动的意见

    国务院关于深入实施“人工智能+”行动的意见 国发〔2025〕11号 各省、自治区、直辖市人民政府,国务院各部委、各直属机构: 为深入实施“人工智能+”行动,推动人工智能与经济社会各行业各领域广泛深度融合,重塑人类生产生活范式,促进生产力革命性跃迁和生产关系深层次变革,加快形成人机协同、跨界融合、共创分享的智能经济和智能社会新形态,现提出如下意见。 一、总体要…

    其他 2025年9月1日
    40400
  • 城市规模划分标准

    国务院关于调整城市规模划分标准的通知 国发〔2014〕51号 各省、自治区、直辖市人民政府,国务院各部委、各直属机构:  改革开放以来,伴随着工业化进程加速,我国城镇化取得了巨大成就,城市数量和规模都有了明显增长,原有的城市规模划分标准已难以适应城镇化发展等新形势要求。当前,我国城镇化正处于深入发展的关键时期,为更好地实施人口和城市分类管理,满足经济社会发展…

    其他 2024年9月18日
    1.4K00
  • 基层医疗卫生机构五类疾病药品采购清单

    湖南省医疗保障局关于公布基层医疗卫生机构五类疾病药品采购清单的通知 湘医保招采函〔2025〕67号  各市州、县市区医疗保障局,各相关医疗机构,各相关企业:     根据《关于调整优化基层医疗卫生机构药品采购清单的通知》(湘医保招采函〔2025〕57号)要求,现将纳入基层医疗卫生机构治疗“高血压、糖尿病、慢性阻塞性肺病、血吸虫病、尘肺病”五类疾病药品采购清单…

    其他 2025年8月6日
    39500
  • 湖南2022年最低工资标准发布

    经湖南省人民政府同意和人力资源社会保障部批准,湖南省人力资源和社会保障厅于近日印发了《关于湖南省2022年调整最低工资标准的通知》(湘人社规〔2022〕6号),决定从2022年4月1日起,调整全省各地最低工资标准。调整后湖南省月最低工资标准(适用于全日制劳动者)分三个档,分别为1930元/月、1740元/月、1550元/月;小时最低工资标准(适用于非全日制劳…

    2022年10月26日
    1.1K00

发表回复

登录后才能评论