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

相关推荐

  • 麒麟操作系统下安装第三方邮件客户端

    第一步:点击电脑桌面左下角,在所有程序中找到并打开【软件商店】,推荐搜索“DocMail”并下载安装。 第二步:打开安装好的第三方邮件客户端,点击【服务器配置】。 第三步:填写邮箱账号、邮箱登录密码、收信服务器、发信服务器,如下图所示。 第四步:返回登录界面,填写邮箱账号和授权密码(注意这里填写的不是邮箱登录密码),如图所示: 邮箱XXXX@163.com授…

    2022年11月30日
    4.6K00
  • 军人军属、退役军人和其他优抚对象基本优待目录清单(全国)

    【全国】优待目录清单(116项) 1.现役军人基本优待目录清单(16项) 2.现役军人家属基本优待目录清单(25项) 3.残疾军人基本优待目录清单(27项) 4.退役军人基本优待目录清单(24项) 5.烈士遗属、因公牺牲军人遗属、病故军人遗属基本优待目录清单(24项)            本文转载自 退役军人事务部 官方网站

    2022年12月8日
    2.6K00
  • 国产电脑(麒麟系统)必用软件之【腾讯文档】

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

    2022年7月22日
    1.9K00
  • 添加网络共享打印机后,无法进行打印

    【适用版本】 银河麒麟桌面操作系统V10 【问题现象】 银河麒麟桌面操作系统V10添加网络共享打印机后,无法进行打印。 【解决方案】 系统防火墙未关闭导致无法进行打印。关闭防火墙有两种方法,包括图形软件关闭和命令行关闭,具体描述如下。 方法1:图形软件关闭防火墙。 打开开始菜单-控制面板-安全中心-网络保护-防火墙,关闭防火墙即可。不同的软件版本,界面不一样…

    2024年11月6日
    1.3K00
  • Linux系统下批量生成不同大小的文件

    在Linux系统下,批量生成不同大小的文件可以使用多种方法,其中最常用的是dd命令。dd是一个强大的工具,用于无格式化地复制文件,通常用于磁盘镜像或者创建特定大小的文件。下面是如何使用dd命令来生成一系列具有不同大小的文件: 假设你需要生成一系列从1MB到10MB的文件,每个文件增加1MB,你可以使用下面的shell脚本来实现: 在这个脚本中: /dev/z…

    其他 2024年6月19日
    1.2K00

发表回复

登录后才能评论