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

相关推荐

  • 湘西自治州住房公积金管理中心关于住房公积金政策调整的通知

    各缴存单位,各县(市、区)管理部,各科室: 为落实国务院、省、州稳经济一系列重大决策部署,充分发挥住房公积金在住房消费中的民生保障作用,有效应对疫情影响,促进州域房地产市场平稳健康发展,现对州住房公积金部分政策调整如下: 一、放宽合作楼盘整体准入条件。房地产开发项目完成基础工程达到“正负零”标准时,在确定施工进度和竣工交付日期的前提下,允许该项目整体准入,取…

    2022年7月20日
    1.0K01
  • 国产电脑(麒麟系统)必用软件之【腾讯文档】

    这么说吧,这个软件是不鸣则已,一鸣惊人。【腾讯文档】除了在线文档的传统功能外,还集成了功能非常丰富的插件,战斗力直接上升两个档次。说实话,我的下巴已经快要惊掉了。废话不多说,直接上教程。大家可以一步步跟着试试。 第一步:打开电脑中的【软件商店】,下载【腾讯文档】。可以在【精品】类别下找到目标,也可以在搜索栏搜索关键字找到目标。如下图所示: 第二步:打开软件,…

    2022年7月22日
    1.8K00
  • 2024年吉首城区(湘西高新区)中小学招生方案

    2024年 2024年吉首城区初中招生工作方案 2024年吉首城区小学招生工作方案 2024年湘西高新区中小学招生工作方案 2023年 2023年吉首城区初中招生工作方案 2023年吉首城区小学招生工作方案 2023年湘西高新区中小学招生工作方案

    其他 2024年6月14日
    1.2K00
  • 今天教大家用Excel制作会议席位卡(酒店就是用的这个方法喔)

    老样子,本文在银河麒麟V10操作系统下,使用WPS 2019演示。 第一步:用尺子量好席位卡的尺寸。常用的尺寸是:长16厘米,宽9.3厘米。 第二步:新建WPS表格,各种调格式。选中A列,设置列宽为16厘米。选中1-100行(假设需要打印100个名字),设置行高9.3厘米。缩放视图为20%或者30%,在视图菜单下设置分页预览,这样一页可以展示更多的内容,方便…

    2022年8月25日
    2.1K00

发表回复

登录后才能评论