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月14日 下午5:05

相关推荐

  • FTP扫描文档配置

    在银河麒麟桌面操作系统中,一般通过配置使用Samba或FTP来扫描文档。本文将介绍如何把文件扫描至FTP服务器,下一篇再介绍配置Samba扫描文档的方法。 一、FTP服务器配置 之前写了一篇搭建FTP服务器的文章,如果安装过FTP服务器,则跳过该步,直接进入第二个步骤:在打印机中设置FTP参数。 1.安装vsftpd 2.备份 vsftpd 的默认配置 3.…

    2024年11月13日
    1500
  • WPS加载项项目实例:时间提醒侧边栏

    本实例简练地介绍了如何新增一个业务内容。 业务需求:显示当前日期和时间;显示距离放学还有多久时间? 先看项目效果图: 01 自定义功能区 在ribbon.xml中添加一个<button/>标签,即在功能区添加button按钮,名称是“时间提醒”,绑定了点击事件用于执行OnAction,并通过getImage获取该按钮的图标。 自定义功能区多出来一…

    2024年11月14日
    1600
  • 解除账户锁定的第二种办法

    解决方案 切换至其他可登录用户并对锁定账户进行解锁 举例说明 例如,系统上的kylin账户由于连续多次输错密码导致kylin账户被锁定,同时系统上存在其他可登录用户(如js1账户),则可登录js1用户进行解锁。 具体操作步骤 01 在登录界面,点击右下角【切换用户】的按钮,选择js1账户,输入js1账户密码登录进入系统桌面,如下图所示。 02&nb…

    2024年11月5日
    4000
  • 国产电脑(银河麒麟系统)如何删除文件和文件夹

    一、删除文件/文件夹:rm 命令 rm 是强大的删除命令,它可以 永久性地 删除文件系统中指定的文件或目录。 在使用 rm 命令删除文件或目录时,系统不会产生任何提示信息。此命令的基本格式为: rm [选项] 文件或目录 选项: -f:强制删除(force),和 -i 选项相反,使用 -f,系统将不再询问,而是直接删除目标文件或目录。 -i:和 -f 正好相…

  • WPS宏编辑器读取身份证信息到电子表格

    解决的实际问题 接访时,需要登记来访人的身份证信息,包括:姓名、性别、年龄、住址、身份证号码。在纸质表格中登记完一个人需要几分钟时间,有时候人数较多的时候需要花费更多的时间完成登记。登记完后,因为手写字迹潦草的原因,不便于识别;也不便于统计、检索。 设计这么一个WPS带宏的电子表格,依托身份证阅读器(本文是高拍仪上集成的身份证阅读器),可以实现3秒钟自动读取…

    2024年10月25日
    12700

发表回复

登录后才能评论
微信公众号