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

相关推荐

  • 添加网络共享打印机后,无法进行打印

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

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

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

  • WPS加载项概述

    WPS加载项是什么? WPS加载项是一组用JavaScript开发的网页程序,通过组件的形式集成到WPS中,专门为拓展WPS Office功能服务。 WPS加载项可以拓展哪些服务? 加载项可以增加额外的功能或增强现有功能,使WPS Office更加灵活和强大。 举个例子: 模板加载项:你可以下载各种专业的文档、表格或演示文稿模板,帮助你快速创建格式化的文件。…

  • 保留数据盘,重装银河麒麟操作系统

    银河麒麟操作系统支持保留数据盘重装系统。本文主要介绍了在保留数据盘的前提下重装银河麒麟桌面操作系统的操作方法。 一、重装前准备 1、在原来的系统中打开终端,在终端输入lsblk命令查看系统数据盘所在的分区。请记下来,重装系统时需要。 2、准备刻录好的系统启动盘,即U盘启动盘或者光盘启动盘。 二、安装系统 以重装银河麒麟桌面操作系统V10为例,具体操作步骤如下…

    2024年11月13日
    1.5K00
  • 系统登录界面多次输错密码导致账户锁定

    【适用版本】银河麒麟桌面操作系统V10  【问题现象】在登录界面,连续多次输错密码,导致账户锁定。现象如下图所示: 【解决方案】解除账户锁定有两种方法:第一种是进入高级模式对锁定账户进行解锁,第二种是切换至其他可正常登录用户并对锁定账户进行解锁。这里我们介绍第一种办法,下一篇我们再介绍第二种办法。 具体操作步骤  01 重启电脑…

    2024年11月5日
    57600

发表回复

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