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

相关推荐

  • 使用楼盘网采集湘西高新区的所有新房住宅

    登录【楼盘网loupan.com】,地区选择【湘西】,进入一级菜单【新房】,根据条件筛选区域为【高新区】、类型为【住宅】,复制网址备用。 本教程使用八爪鱼采集器采集数据,具体步骤如下: 1.打开链接:登录八爪鱼采集器,粘贴网址,点击【开始采集】。 2.循环列表:鼠标点击网页列表中的第一个内容,弹出框中点击【选中全部】,此时数据采集界面会显示列表中的所有信息,…

    2022年10月14日
    59000
  • 第二课:如何安装公文字体

    从上节课内容我们了解到,公文涉及三类字体:方正小标宋简体/方正小标宋_GBK、楷体_GB2312、仿宋_GB2312。 接下来,我们开始一步一步安装字体。 操作系统环境:国产银河麒麟V10操作系统 第一步:下载公文字体并解压。 第二步:打开系统中的软件商店,搜索“字体管理器”并打开, 下图所示: 点击左下角“齿轮” 图案, 弹出框 选中“安装字体”,选中下载…

    2022年7月21日
    6.9K00
  • 四川省退役军人优待目录

    第一批优待项目清单 第二批优待项目清单

    其他 2023年1月27日
    7.6K00
  • 今天给大家分享一个准备会务资料的神器:自动生成座次表

    这个小程序解决了什么问题?大家在准备会务资料的时候有没有发现,参会人员名单总是变动,座次表排了一遍又一遍,参会人员姓名核对了一遍又一遍,产生了N次重复性的工作。怎么办?这个小程序就是为了解决这种参会人员变动带来的重复性工作,工作效率提高N倍。 使用步骤:【在国产电脑银河麒麟V10操作系统下测试通过】 第一步:打开【模板.xlsx】文件。1.在【参会人员名单】…

    其他 2022年8月4日
    3.4K00
  • 使用iptables配置防火墙规则

    在银河麒麟桌面操作系统V10,如果遇到通过安全中心配置防火墙规则不生效的情况,则可以使用iptables配置防火墙规则。 一、防火墙基础知识 1.什么是防火墙? 防火墙是一种网络安全系统,用于保护计算机网络免受未经授权的访问、攻击和其他安全威胁。它通过监控和控制进出网络的数据流来实现这一目的。防火墙可以是硬件设备、软件程序或两者的结合。 2.iptables…

    2024年11月13日
    2.8K00

发表回复

登录后才能评论