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

相关推荐

  • 年末巨献,重磅来袭!你想要的数学口算练习本来了

    数学口算,也就是心算,是指不借助任何工具,仅凭大脑进行快速计算的能力。 口算是数学学习中的一个重要组成部分,对小学生的数学能力和整体认知发展都有着重大的影响。 曾经,在网上买口算练习本,有的题型单一,难度不够;有的注重排版,题量不够;有的花里胡哨,既有计算题,又有应用题,题量少,难度低,无法有效锻炼综合运算能力。 自从老师布置了长期任务,要求每天打卡计算10…

    2024年11月7日
    22700
  • 为什么身份证号码复制到电子表格会出错

    Excel单元格常规格式只能输入11个数字,手机号码就是上限了。 超过11个数字就会显示错误,但是单元格内的数值是正确的。 根据测算,15位以内的数字,数值都是正确的。超过15位数,从第16位开始变为0。也就是说如果批量复制身份号码的话,所有身份证号码的后三位都会变成000。 建议复制身份证号码, 单元格格式调成“文本”。

    2022年9月5日
    1.8K00
  • 国产操作系统常用的命令式小工具

    常用命令 查看电脑软硬件配置:hardinfo 系统截图(可以延迟抓取截图):mate-screenshot –interactive 计算器:mate-calc 字体安装管理器:font-manager 搜索文件:mate-search-tool 屏幕键盘:onboard 网络工具:gnome-nettool 在哪里?如何输入命令? 1、电脑桌…

    2024年9月22日
    66100
  • 银河麒麟桌面操作系统搭建FTP服务器

    FTP是一个文件传输协议,主要是在互联网上提供文件储存和访问服务的计算机,一个FTP服务器可以对多个客户端提供服务。本文主要介绍在银河麒麟桌面操作系统V10上如何搭建FTP服务器以及在客户端如何访问FTP服务器的操作方法。 一、操作环境 服务端:银河麒麟桌面操作系统V10 客户端:银河麒麟桌面操作系统V10 二、服务端配置 说明:以下命令均在终端执行。鼠标点…

    2024年11月13日
    1.4K00
  • 麒麟操作系统下安装第三方邮件客户端

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

    2022年11月30日
    2.7K00

发表回复

登录后才能评论