【国家标准】 中文办公软件 网页应用编程接口

ICS35.240.20
中华人民共和国国家标准
GB/T34997—2017
中文办公软件
网页应用编程接口
Chinese office softwareAPI for Web application2017-11-01发布
中华人民共和国国家质量监督检验检疫总局中国国家标准化管理委员会
2018-05-01实施
规范性引用文件
术语和定义
接口描述
插件初始化
文件接口
界面控制接口
查找替换接口
书签接口
文档编辑接口
页面设置接口
表格接口
图片接口
文本框接口
插入内容接口
修订和审批接口
自定义域处理接口
基础监听接口
事件监听的消息名称表
附录A（规范性附录）
参考文献
GB/T34997—2017
本标准按照GB/T1.1一2009给出的规则起草GB/T34997—2017
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本标准由全国信息技术标准化委员会（SAC/TC28）提出并归口。本标准起草单位：中国电子技术标准化研究院、中标软件有限公司，无锡永中软件有限公司，珠海金山软件有限公司、北京信息科技大学等。本标准主要起草人：方春燕、张展新、吴新松、李宁、丁伟、王耀、刘瑜、王剑、李幸、苗宗利、柳杨詹欣坤、田英爱
GB/T34997—2017
GB/T21026《中文办公软件应用编程接口规范》定义了与中文办公软件文档格式（简称“标文通”UOF)相适应的中文办公软件应用编程接口，用于读写“标文通”文档。在中文办公软件集成应用过程中，办公软件需要为基于浏览器的网页应用提供统一的接口，实现对办公软件的操作。本标准以java语言对接口进行描述，C++语言可以参考实现，IV
1范围
网页应用编程接口
中文办公软件
GB/T34997—2017
本标准规定了中文办公软件的网页应用编程接口，包括文件接口、界面控制接口、查找替换接口、书签接口、文档编辑接口、页面设置接口、表格接口、图片接口、文本框接口、插人内容接口、修订和审批接口、自定义域处理接口和基础监听接口等接口定义。本标准适用于中文办公软件产品文字处理组件和网页集成应用的开发和测试。2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单)适用于本文件。GB/T20916
中文办公软件文档格式规范
3术语和定义
下列术语和定义适用于本文件。3.1
interface definition language接口定义语言
用于描述对象实现所提供的，客户端对象所调用的服务接口的描述语言。接口描述
插件初始化
功能说明：
初始化插件。
接口原型：
object init(string tagID, string width, string height)参数说明（3个参数）：
参数1：tagID插件所处网页标签的id位置；参数2：width插件宽度，单位像素；参数3：height插件高度，单位像素。返回值说明：
成功则返回初始化后的插件对象；失败则返回null备注：
tagID所对应的标签的innerHTML内容替换为插件；width和height遵循html规范的要求。本接口仅用于打开单个文件。
GB/T34997—2017
2文件接口
4.2.1创建空文件
功能说明：
创建空文件。
接口原型：
boolean createDocument(string type)参数说明（1个参数）：
参数1：type文件类型，uot表示符合GB/T20916的文字处理文档。返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现备注：
打开本地文档
功能说明：
打开本地文件。
接口原型：
boolean openDocument(string fileName, boolean readOnly)参数说明（2个参数）：
参数1：fileName
本地文件的全路径，包括扩展名：参数2：readOnly为true时表示按只读打开，否则按可编辑打开。返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现备注：
如果扩展名是文档模板，如为“uott”，则按模板创建符合GB/T20916的新文档。4.2.3打开远程文档
功能说明：
打开远程文件。
接口原型：
booleanopenDocumentRemote(stringURL,boolean readOnly)参数说明（2个参数）：
参数1：URL远程文件的URL全路径，包括扩展名；参数2：readOnly为true时表示按只读打开，否则按可编辑打开。返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。备注：
如果扩展名是文档模板，如“uott”，则按模板创建一新文件。4.2.4以监听模式打开文档
功能说明：
GB/T34997—2017
以监听模式打开一个文档，该函数仅适用于插件且弹出式（非嵌人式）窗口模式接口原型：
boolean openFileWithListener(stringfileName,booleanreadOnly)参数说明（2个参数）：
参数1：fileName本地文件的全路径，包括扩展名：参数2：readOnly为true时表示按只读打开，否则按可编辑打开。返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。备注：
如果扩展名是文档模板，如\uott”，则按模板创建一新文件。4.2.5保存到本地
功能说明：
将文件保存在本地，扩展名是模板则保存为模板，不弹出对话框。接口原型：
boolean saveAs(string fileName)参数说明（1个参数）：
参数l：fileName本地文件的全路径，包括扩展名。返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现备注：
4.2.6通过对话框保存到本地
功能说明：
通过弹出对话框将文件保存在本地。接口原型：
boolean saveAsO
参数说明：无。
返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。备注：
4.2.7保存到远程
功能说明：
将文件保存到远程地址。
接口原型：
boolean saveURL(stringURL,stringfileName)参数说明（2个参数）：
参数1：URL处理系统提供的页面地址；参数2：fileName文件名，包括扩展名。返回值说明：
GB/T34997—2017
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现备注：
4.2.8打印
功能说明：
不调对话框打印当前文件。
接口原型：
booleanprint()
参数说明：无。
返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现备注：
当未设置默认的本地打印机或无法直接打印时，弹出打印对话框。4.2.9调用打印对话框
功能说明：
调用打印对话框。
接口原型：
booleanshowPrintDialogO
参数说明：无。
返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现备注：
打印预览
功能说明：
打印预览功能。
接口原型：
booleanprintPreviewO
参数说明：无。
返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现备注：
打印设置
功能说明：
设定内容打印设置。
接口原型：
booleanprintSetting(intnPrint)参数说明（1个参数）：
GB/T34997—2017
参数1：nPrint打印设置参数，为以下取值的和。1表示页面背景，2表示图片和对象，4表示隐藏的文字，8表示文字占位符，16表示表单控件。返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现备注：
2打印/不打印修订文字
功能说明：
按照参数要求直接打印。
接口原型：
boolean printRevision(int enable)参数说明（1个参数）：
参数1：enable为0表示打印修订状态；为1表示打印原始状态（修订前）；为2表示打印最终状态(修订后）。
返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。备注：
3关闭
功能说明：
关闭文档。
接口原型：
boolean close)
参数说明：无。
返回值说明：
rue表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现备注：
以监听模式关闭文档
功能说明：
以监听模式关闭文档，该函数仅适用于插件且弹出式（非嵌人式）窗口模式接口原型：
boolean closeFileWithCloseListenerO参数说明：无。
返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现。备注：
GB/T34997—2017
界面控制接口下载标准就来标准下载网
显示/隐藏工具菜单
功能说明：
显示或隐藏全部工具菜单。
接口原型：
booleansetToolbarAllVisible(booleanenable)参数说明（1个参数）：
参数1：enable为true表示显示，为false表示不显示。返回值说明：
true表示接口调用成功，功能能够实现；false表示接口调用失败，功能未能实现备注：
显示/隐藏指定工具菜单
功能说明：
显示或隐藏指定工具菜单。
接口原型：
boolean setToolbarPartVisible(int toolbarNum,boolean enable)参数说明（2个参数）：
参数l：toolbarNum
工具栏编号，编号含义见表1。
表1工具栏编号及含义
工具栏编号
文字式样
段落式样
文本框
页眉页脚
自定义域
页面布局
页边距
工具栏名称
小提示：此标准内容仅展示完整标准里的部分截取内容，若需要完整标准请到上方自行免费下载完整标准文档。