GB/T 33478-2016 党政机关电子公文应用接口规范

　　ICS 35.240.30 L 76

　　中 华 人 民 共 和 国 国 家 标 准

　　GB/T 33478—2016

　　党政机关电子公文应用接口规范

　　Application programminginterfacespecification forelectronicofficial

　　documentofParty and governmentorgans

　　2016-12-30发布 2017-07-01实施

　　中华人民共和国国家质量监督检验检疫总局中 国 国 家 标 准 化 管 理 委 员 会

　　发

　　布

　　GB/T 33478—2016

　　GB/T 33478—2016

　　前 言

　　本标准按照 GB/T 1. 1—2009给出的规则起草 。

　　请注意本文件的某些内容可能涉及专利 。本文件的发布机构不承担识别这些专利的责任 。

　　本标准由中共中央办公厅 、国务院办公厅提出 。

　　本标准由国家电子文件管理部际联席会议办公室归 口 。

　　本标准起草单位 : 中办信息中心 、中国电子技术标准化研究院 、中标软件有限公司 、珠海金山办公软件有限公司 、无锡永中软件有限公司 、北京数科网维技术有限责任公司 、航天福昕软件(北京)有限公司 、浪潮电子信息产业股份有限公司 、大连倚天软件股份有限公司 。

　　本标准主要起草人 :丛培 勇 、方 春 燕 、高 林 、李 海 波 、高 鹏 、苗 宗 利 、冯 辉 、贾 曙 瑞 、王 寒 冰 、陈 亚 军 、袁峰 、王雷 、孙洪桥 、白雪冬 、任广义 、荣明军 、史周波 、刘瑜 、陈留勇 。

　　党政机关电子公文应用接口规范

　　1 范围

　　本标准规定了电子公文标准化套件的网页二次开发接 口 。

　　本标准适用于党政机关电子公文系统及电子公文标准化套件的设计 、开发和测试 。

　　2 规范性引用文件

　　下列文件对于本文件的应用是必不可少的 。凡是注 日期的引用文件 ,仅注 日期的版本适用于本文件 。凡是不注日期的引用文件 ,其最新版本(包括所有的修改单)适用于本文件 。

　　GB/Z 21025—2007 XML使用指南

　　GB/T 33476. 1—2016 党政机关电子公文格式规范 第 1部分 :公文结构

　　GB/T 33476. 2—2016 党政机关电子公文格式规范 第 2部分 :显现

　　GB/T 33476. 3—2016 党政机关电子公文格式规范 第 3部分 :实施指南

　　GB/T 33480—2016 党政机关电子公文元数据规范

　　GB/T 33482—2016 党政机关电子公文系统建设规范

　　3 术语和定义

　　GB/T 33482—2016、GB/Z 21025—2007界定的以及下列术语和定义适用于本文件 。

　　3. 1

　　电子公文标准化套件 electronicofficialdocumentstandard suite

　　生成 、处理符合 GB/T 33476—2016要求的电子公文的相关工具软件的集合 ,包括文字处理软件 、版式阅读软件和签章组件 。

　　3.2

　　文字处理软件 word processor

　　用于编辑 、排版电子公文的软件 ,主要功能包括图 、文 、表内容的编辑 、修订和转版等 。 3.3

　　版式阅读软件 fixed-layoutreadingsoftware

　　用于阅读和打印电子公文的软件 ,主要功能包括打印 、盖章 、注释和签批等 。

　　3.4

　　签章组件 signaturecomponent

　　为盖章和验章功能提供密码和认证相关服务的电子印章客户端 。

　　4 缩略语

　　下列缩略语适用于本文件 。

　　OFD:开放版式文档(Open Fixed-layoutDocument)

　　UOT: 中文办公软件文档格式规范(Uniform Office documentFormatfor Text)

　　IDL:接口描述语言(Interface description language)

　　GB/T 33478—2016

　　5 应用环境和形式

　　5. 1 B/S应用

　　电子公文标准化套件在 B/S(浏览器/服务器) 应用环境中宜采用浏览器插件形式嵌入于网页 。正文中采用 IDL 的形式描述接 口 ,其对应 JavaScript形式见附录 A 和附录 B。

　　5.2 调用形式

　　除初始化(init)函数之外 ,插件接口在页面进行调用时应采用对象加方法的形式 , 即如 :

　　office.openDocument("c:/test.uot",false) ;不应通过如下方式直接调用 :

　　openDocument("c:/test.uot",false) ;

　　6 文字处理软件接口

　　6. 1 插件初始化

　　功能说明 :

　　初始化插件 。将 tagID所对应标签的 innerHTML 内 容 替 换 为 插 件;width和 height应 遵 循html规范的要求 。

　　接口原型 :

　　IWordProcessor init(in string tagID,in string width,in string height) ;参数说明(3个参数) :

　　参数 1:tagID 插件所处网页标签的 id;

　　参数 2:width 插件宽度 ;

　　参数 3:height 插件高度 。

　　返回值说明 :

　　成功则返回初始化后的插件(接口实现) ;失败则返回 null。

　　6.2 获取插件版本

　　功能说明 :

　　获取插件版本信息 。

　　接口原型 :

　　string getPluginVersion() ;

　　参数说明 :无 。

　　返回值说明 :

　　插件版本信息 。

　　备注 :

　　插件版本信息宜包含日期信息(YYYYMMDD) 。

　　6.3 文件操作接口

　　6.3. 1 创建空文件

　　功能说明 :

　　创建空文件 。

　　接口原型 :

　　boolean createDocument(in string type) ;参数说明(1个参数) :

　　参数 1:type 文件格式 ,默认取值为“uot”。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.3.2 打开本地文档

　　功能说明 :

　　打开本地的文档 。

　　接口原型 :

　　boolean openDocument(in string fileName,in boolean readOnly) ;参数说明(2个参数) :

　　参数 1:fileName 本地文档全路径 ,包括扩展名 ;

　　参数 2:readOnly 是否只读方式打开 ,true表示只读方式 ,false表示可写方式 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.3.3 打开远程文档

　　功能说明 :

　　打开远程的文档 。

　　接口原型 :

　　boolean openDocumentRemote(in string strURL,in boolean readOnly) ;参数说明(2个参数) :

　　参数 1:strURL 远程文档地址 ;

　　参数 2:readOnly 是否只读方式打开 ,true表示只读方式 ,false表示可写方式 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.3.4 保存到本地

　　功能说明 :

　　将文档保存到本地 。

　　接口原型 :

　　boolean saveAs(in string fileName) ;参数说明(1个参数) :

　　参数 1:fileName 本地文档全路径 ,包括扩展名 。 当为空时弹出对话框确认保存位置 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.3.5 保存到远程

　　功能说明 :

　　将文档保存到远程,应使用 HTTP通用文件上传协议。

　　接口原型 :

　　boolean saveURL(in string strURL,in string fileName) ;参数说明(2个参数) :

　　参数 1:strURL 保存的位置 。可由应用实现接收数据上传的服务并提供服务地址 ;

　　参数 2:fileName 保存的文件名 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.3.6 打印

　　功能说明 :

　　按系统默认的打印设置直接打印当前文档 。

　　接口原型 :

　　boolean print() ;

　　参数说明 :无 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.3.7 打印/不打印修订内容

　　功能说明 :

　　按修订痕迹参数要求直接打印文档 。

　　接口原型 :

　　boolean printRevision(in shortstatus) ;参数说明(1个参数) :

　　参数 1:status 打印时的修订痕迹显示模式 ;

　　0 表示打印修订痕迹 ;

　　1 表示打印原始状态 ;

　　2 表示打印最终状态 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.3. 8 关闭

　　功能说明 :

　　关闭文档 。

　　接口原型 :

　　boolean close() ;

　　参数说明 :无 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.4 界面控制接口

　　6.4. 1 设置文档保护模式

　　功能说明 :

　　设置文档保护模式 。

　　接口原型 :

　　boolean enableProtect(in boolean bEnable) ;参数说明(1个参数) :

　　参数 1:bEnable 文档是否可保护 ,true表示只读 ,false表示可编辑 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.4.2 显示/隐藏工具菜单

　　功能说明 :

　　显示或隐藏全部工具菜单 。

　　接口原型 :

　　boolean setToolbarAllVisible(in boolean bVisible) ;参数说明(1个参数) :

　　参数 1:bVisible 是否显示 ,true表示显示 ,false表示隐藏 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.4.3 启用/禁用内容复制

　　功能说明 :

　　启用或禁用复制 。

　　接口原型 :

　　boolean enableCopy(in boolean bEnable) ;参数说明(1个参数) :

　　参数 1:bEnable 是否允许复制 ,true表示允许 ,false表示禁止 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.4.4 启用/禁用内容剪切

　　功能说明 :

　　启用或禁用剪切 。

　　接口原型 :

　　boolean enableCut(in boolean bEnable) ;参数说明(1个参数) :

　　参数 1:bEnable 是否允许剪切 ,true表示允许 ,false表示禁止 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　备注 :

　　该接口已不推荐使用 ,相应功能可用 “启用或禁止复制 ”和 “设置文档保护模式 ”组合实现 。

　　6.4.5 开启/停止修订

　　功能说明 :

　　开启或停止修订 ,用于进入或退出痕迹保留状态 。

　　接口原型 :

　　boolean enableRevision(in boolean bEnable) ;参数说明(1个参数) :

　　参数 1:bEnable 是否允许修订 ,true表示允许 ,false表示禁止 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.4.6 设置页面显示比例

　　功能说明 :

　　设置页面显示比例 。

　　接口原型 :

　　void setZoomRadio(in floatzoomValue) ;参数说明(1个参数) :

　　参数 1:zoomValue 页面显示比例的值 ,120表示 120% 。

　　返回值说明 :无 。

　　6.4.7 获取当前页面比例

　　功能说明 :

　　获取页面显示比例的值 。

　　接口原型 :

　　floatgetZoomRadio() ;参数说明 :无 。

　　返回值说明 :

　　返回页面显示比例值 。

　　6.4. 8 启用/禁用组件

　　功能说明 :

　　设置工具栏或菜单栏中指定名称的按钮或菜单项是否可用 。

　　接口原型 :

　　void setCompositeEnable (in string CompName,boolean bEnable) ;参数说明(2个参数) :

　　参数 1:CompName 界面元素的标识 ,见附录 C;

　　参数 2:bEnable,是否可用 ,true表示可用 ,false表示不可用 。

　　备注 :

　　如果是可控制界面元素列表之外的标识 ,不发生任何作用 。

　　6.5 文档编辑接口

　　6.5. 1 设置公文标识

　　功能说明 :

　　设置公文的 “标识 ”元数据 。

　　接口原型 :

　　boolean setDocumentId(in string docid) ;

　　参数说明(1个参数) :

　　参数 1:docid 公文的标识信息 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　备注 :

　　公文标识信息存储在自定义元数据“公文标识 ”中 ,其命名见 GB/T 33480—2016。

　　6.5.2 获取公文标识

　　功能说明 :

　　获取公文的 “标识 ”元数据 。

　　接口原型 :

　　string getDocumentId() ;参数说明 :无 。

　　返回值说明 :

　　公文标识信息 。

　　6.5.3 设置公文文种

　　功能说明 :

　　设置公文的 “文种 ”元数据 。

　　接口原型 :

　　boolean setDocumentType(in string documentType) ;参数说明(1个参数) :

　　参数 1:documentType 公文文种 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　备注 :

　　公文文种存储在自定义元数据“文种 ”中 ,文种取值见 GB/T 33480—2016附录 A。

　　6.5.4 获取公文文种

　　功能说明 :

　　获取公文的 “文种 ”元数据 。

　　接口原型 :

　　string getDocumentType() ;参数说明 :无 。

　　返回值说明 :

　　公文文种信息 。

　　6.5.5 设置元数据

　　功能说明 :

　　为插件中的当前文档设置元数据 。插件未打开文档时调用无效 。

　　接口原型 :

　　void setMetaData(in string id,in string val) ;参数说明(2个参数) :

　　参数 1:id 元数据的名称 ;

　　参数 1:val 元数据的值 。

　　返回值说明 :无 。

　　6.5.6 获取元数据

　　功能说明 :

　　获取为插件中的当前文档的元数据 。插件未打开文档时调用无效 。

　　接口原型 :

　　string getMetaData(in string id) ;参数说明(1个参数) :

　　参数 1:id 元数据的名称 。

　　返回值说明 :

　　元数据的值 。

　　6.5.7 插入图片

　　功能说明 :

　　将图片插入到当前光标所在页面的指定位置 ,可用于印章 、二维码 。如果未给定位置坐标和图片大小 , 图片以 “嵌入型 ”插入到当前光标所在位置 。

　　接口原型 :

　　boolean insertPicture(in string pictureFile, in float left, in float top, in float width, in float height) ;

　　参数说明(5个参数) :

　　参数 1:pictureFile 本地图片用文件名 ,远程图片用 URL;

　　参数 2:left 左上角的横坐标 ,单位为 mm;

　　参数 3:top 左上角的纵坐标 ,单位为 mm;

　　参数 4:width 图片宽度 ,单位为 mm;

　　参数 5:height 图片高度 ,单位为 mm。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 ;如果文档为只读状态应返回 false。

　　6.5. 8 提取全文文本

　　功能说明 :

　　返回全文的纯文本内容 。

　　接口原型 :

　　string getText() ;

　　参数说明 :无 。

　　返回值说明 :

　　全文的纯文本内容 。

　　6.5.9 退格操作

　　功能说明 :

　　光标从当前位置执行退格操作 。

　　接口原型 :

　　boolean backspace() ;参数说明 :无 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 ;如果文档为只读状态应返回 false。

　　6.5. 10 插入文本

　　功能说明 :

　　在当前光标位置插入文本内容 。

　　接口原型 :

　　boolean insertText(in string text) ;参数说明(1个参数) :

　　参数 1:text 插入的文本 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 ;如果文档为只读状态应返回 false。

　　6.6 表格接口

　　6.6. 1 插入表格

　　功能说明 :

　　在光标当前位置插入表格 。

　　接口原型 :

　　voidinsertTable (in string tableName,in intcolumnCount,in introwCount) ;参数说明(3个参数) :

　　参数 1:tableName 表格名称 ;

　　参数 2:columnCount 表格的列数 ;

　　参数 3:rowCount 表格的行数 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 ;如果文档为只读状态应返回 false。

　　6.6.2 删除表格

　　功能说明 :

　　删除指定名称的表格 。

　　接口原型 :

　　void removeTable(in string tableName) ;参数说明(1个参数) :

　　参数 1:tableName 表格名称 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 ;如果文档为只读状态应返回 false。

　　6.6.3 设置表格的行高

　　功能说明 :

　　设置表格的行高 。

　　接口原型 :

　　boolean setRowHeight(in string tableName,in intnum ,in floatheight) ;参数说明(3个参数) :

　　参数 1:tableName 表格名称 ;

　　参数 2:num 表格行索引 ,从 0 开始 ;

　　参数 3:height 行高度 ,单位 mm。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 ;如果文档为只读状态应返回 false。

　　6.6.4 设置表格的列宽

　　功能说明 :

　　设置表格的列宽 。

　　接口原型 :

　　boolean setColumnWidth (in string tableName,in intnum ,in floatwidth) ;参数说明(3个参数) :

　　参数 1:tableName 表格名称 ;

　　参数 2:num 表格列索引 ,从 0 开始 ;

　　参数 3:width 列宽度 ,单位 mm。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 ;如文档为只读状态应返回 false。

　　6.6.5 设置单元格保护属性

　　功能说明 :

　　对指定表格的指定单元格设置保护或取消保护操作 。

　　接口原型 :

　　boolean setCellProtected(in string tableName,in introw,in intcolumn,in boolean isProtected) ;参数说明(4个参数) :

　　参数 1:tableName 表格名称 ;

　　参数 2:row 单元格所在表格的行索引 ,从 0 开始 ;

　　参数 3:column 单元格所在表格的列索引 ,从 0 开始 ;

　　参数 4:isProtected 是否保护指定单元格 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 ;如果文档为只读状态应返回 false。

　　6.6.6 光标定位单元格

　　功能说明 :

　　光标跳至指定表格指定单元格 。

　　接口原型 :

　　void cursorToCell(in string tableName,in introw,in intcolumn) ;参数说明(3个参数) :

　　参数 1:tableName 表格名称 ;

　　参数 2:row 单元格所在表格行索引 ,从 0 开始 ;

　　参数 3:column 单元格所在表格列索引 ,从 0 开始 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.7 修订和审阅接口

　　6.7. 1 启用/禁用接受修订按钮

　　功能说明 :

　　启用或禁用工具栏中接受修订按钮 。

　　接口原型 :

　　boolean enableRevisionAcceptCommand(in boolean bEnable) ;参数说明(1个参数) :

　　参数 1:bEnable 是否启用接受修订按钮 ,true:启用接受修订;false:禁用接受修订 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.7.2 启用/禁用拒绝修订按钮

　　功能说明 :

　　启用或禁用工具栏中拒绝修订按钮 。

　　接口原型 :

　　boolean enableRevisionRejectCommand(in boolean bEnable) ;参数说明(1个参数) :

　　参数 1:bEnable 是否启用拒绝修订按钮 ,true表示启用拒绝修订 ,false表示禁用拒绝修订 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.7.3 设置修订痕迹的显示模式

　　功能说明 :

　　设置修订痕迹的显示模式 。

　　接口原型 :

　　boolean showRevision(in shortstatus) ;参数说明(1个参数) :

　　参数 1:status 修订痕迹显示模式 ;

　　0 表示显示修订痕迹 ;

　　1 表示显示文档原始状态 ;

　　2 表示显示文档最终状态 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.7.4 设置用户名

　　功能说明 :

　　设置当前的用户名 ,此信息将用于批注或修订 。

　　接口原型 :

　　boolean setUserName(in string userName) ;参数说明(1个参数) :

　　参数 1:userName 要使用的用户名 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.7.5 获取用户名

　　功能说明 :

　　获取当前的用户名 。

　　接口原型 :

　　string getUserName() ;参数说明 :无 。

　　返回值说明 :

　　用户名 。

　　6.7.6 按用户显示修订

　　功能说明 :

　　根据指定作者筛选修订和批注 。

　　接口原型 :

　　void showRevisionAuthor(in string author,in boolean bShow) ;参数说明(2个参数) :

　　参数 1:author 指定的修订作者 ;

　　参数 2:bShow 是否显示 ,true表示显示修订 ,false表示不显示 。

　　返回值说明 :

　　true表示接口调用成功;false表示接口调用失败或功能未能实现 。

　　6.7.7 接受所有修订

　　功能说明 :

　　接受所有修订者的修订内容 。

　　接口原型 :

　　boolean acceptAllChanges() ;参数说明 :无 。

　　返回值说明 :

　　true表示接口调用成功;false表示接口调用失败或功能未能实现 。

　　6.7. 8 拒绝所有修订

　　功能说明 :

　　拒绝所有修订者的修订内容 。

　　接口原型 :

　　void rejectAllChanges() ;参数说明 :无 。

　　返回值说明 :

　　true表示接口调用成功;false表示接口调用失败或功能未能实现 。

　　6.7.9 按用户接受修订

　　功能说明 :

　　根据指定作者筛选修订 ,并接受或拒绝其修订 。

　　接口原型 :

　　voidfilterCertainAuthor(in string author,in boolean bAccept) ;参数说明(2个参数) :

　　参数 1:author 指定修订的作者 ;

　　参数 2:bAccept 是否接受修订 ,true表示接受 ,false表示拒绝 。

　　返回值说明 :

　　true表示接口调用成功;false表示接口调用失败或功能未能实现 。

　　6. 8 公文域处理接口

　　6. 8. 1 插入公文域

　　功能说明 :

　　在当前光标处插入公文域 。

　　接口原型 :

　　boolean insertDocumentField(in string id) ;参数说明(1个参数) :

　　参数 1:id 公文域的标识或名称 ,见 GB/T 33476. 2—2016表 1。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6. 8.2 设置公文域内容

　　功能说明 :

　　设置公文域的值 ,替换原有内容 。

　　接口原型 :

　　boolean setDocumentField(in string id,in string val) ;参数说明(2个参数) :

　　参数 1:id 公文域的标识或名称 ,见 GB/T 33476. 2—2016表 1;

　　参数 2:val 待设置的值 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6. 8.3 获取公文域列表

　　功能说明 :

　　获取所有公文域的标识或名称 。

　　接口原型 :

　　sequence< string> getAllDocumentField() ;参数说明 :无 。

　　返回值说明 :

　　全部公文域标识或名称的列表 。

　　6. 8.4 删除公文域

　　功能说明 :

　　删除公文域 。

　　接口原型 :

　　boolean deleteDocumentField(in string id) ;参数说明(1个参数) :

　　参数 1:id 公文域的标识或名称 ,见 GB/T 33476. 2—2016表 1;

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6. 8.5 设置公文域是否显示

　　功能说明 :

　　设置公文域是否显示 。

　　接口原型 :

　　boolean showDocumentField(in string id,in boolean bVisible) ;参数说明(2个参数) :

　　参数 1:id 公文域的标识或名称 ,见 GB/T 33476. 2—2016表 1;

　　参数 2:bVisible 是否显示公文域 ,true表示可见 ,false表示不可见 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6. 8.6 获取公文域内容

　　功能说明 :

　　获取公文域内容 。

　　接口原型 :

　　string getDocumentFieldValue(in string id) ;参数说明(1个参数) :

　　参数 1:id 公文域的标识或名称 ,见 GB/T 33476. 2—2016表 1。

　　返回值说明 :

　　公文域中的纯文本内容 ;表格返回纯文本 , 图片不返回数据 。

　　6. 8.7 设置公文域是否可编辑

　　功能说明 :

　　设置公文域是否可编辑 。

　　接口原型 :

　　boolean enableDocumentField(in string id,in boolean bEnable) ;参数说明(2个参数) :

　　参数 1:id 公文域的标识或名称 ,见 GB/T 33476. 2—2016表 1;

　　参数 2:bEnable 是否可编辑 ,true可编辑表示 ,false表示不可编辑 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6. 8. 8 公文域插入文档内容

　　功能说明 :

　　将指定文档的全部内容插入指定的公文域中 ,主要用于正文 。

　　接口原型 :

　　boolean insertDocument(in string id,in string fileName) ;参数说明(2个参数) :

　　参数 1:id 公文域的标识或名称 ,见 GB/T 33476. 2—2016表 1;

　　参数 2:fileName 需要插入的文档全路径 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6. 8.9 移动光标到公文域指定位置

　　功能说明 :

　　将光标移动到指定公文域的指定位置 。

　　接口原型 :

　　boolean cursorToDocumentField(in string id,in shortposition) ;参数说明(2个参数) :

　　参数 1:id 公文域的标识或名称 ,见 GB/T 33476. 2—2016表 1;

　　参数 2:position 光标移动到的公文域的位置 ;

　　1 表示公文域标记前部(在公文域之外) ;

　　2 表示公文域标记后部(在公文域之外) ;

　　3 表示公文域文本前端(在公文域之内) ;

　　4表示公文域文本后端(在公文域之内) 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　6.9 事件监听接口

　　6.9. 1 注册操作监听

　　功能说明 :

　　注册操作(打开 、保存 、打印文档等)监听 。

　　接口原型 :

　　string registListener(in string operateId,in string funcName,in boolean bAfter) ;参数说明(3个参数) :

　　参数 1:operateId 需要被设置监听的操作标识 ,见附录 D;

　　参数 2:funcName 回调函数名 ;

　　参数 3:bAfter 是否在操作后触发 。

　　返回值说明 :

　　监听器标识 。

　　6.9.2 注销指定监听

　　功能说明 :

　　注销指定的监听 。

　　接口原型 :

　　void unRegistListener(in string listenerId) ;参数说明(1个参数) :

　　参数 1:listenerId 待移除的监听器标识 ,来源于 registListener的返回值 。

　　返回值说明 :无 。

　　7 版式阅读软件接口

　　7. 1 插件初始化

　　功能说明 :

　　初始化插件 。将 divId所对应 DIV标签的 innerHTML 内容替换为插件;width和 height遵循html规范的要求 。

　　接口原型 :

　　IOFDReader init(in string divId,in string width,in string height) ;参数说明(3个参数) :

　　参数 1:divId 插件所处网页标签的 id;

　　参数 2:width 插件宽度 ;

　　参数 3:height 插件高度 。

　　返回值说明 :

　　成功则返回初始化后的插件变量 ;失败则返回 null。

　　7.2 获取插件版本

　　功能说明 :

　　获取插件版本信息 。

　　接口原型 :

　　string getPluginVersion() ;

　　参数说明 :无 。

　　返回值说明 :

　　插件版本信息 。

　　备注 :

　　插件版本信息宜包含日期信息(YYYYMMDD) 。

　　7.3 文件操作接口

　　7.3. 1 打开文档

　　功能说明 :

　　打开指定文件 。

　　接口原型 :

　　boolean openFile(in string strURL,in boolean readOnly) ;参数说明(2个参数) :

　　参数 1:strURL 文件名 ,可以是本地文件 ,如“D:/files/xxxxx. ofd”;

　　也可以是远程文件,如“http://localhost:88/files/xxxx. ofd”。

　　参数 2:readOnly 是否以只读方式打开 ,true表示只读方式打开;false表示可编辑(注释或盖章)方式打开 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　7.3.2 保存文档

　　功能说明 :

　　保存为指定文件,保存为远程文件时应使用 HTTP通用文件上传协议。

　　接口原型 :

　　boolean saveFile(in string strURL) ;参数说明(1个参数) :

　　参数 1:strURL 保存的位置 ,可以是本地文件 ,如“D:/files/xxxxx. ofd”;也可以是远程文件 ,如“http://localhost:88/files/xxxx. ofd”。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　7.3.3 打印文件

　　功能说明 :

　　直接打印文件 ,并按指定的打印任务名称和灰度打印设置执行 。

　　接口原型 :

　　void printFile(in string docName,in boolean bGray) ;参数说明(2个参数) :

　　参数 1:docName 发送到打印机的打印任务名称 ;

　　参数 2:bGray 是否灰度打印 ,true表示灰度打印 ,false表示正常打印 。

　　返回值说明 :

　　无 。

　　7.3.4 关闭文档

　　功能说明 :

　　关闭当前的文档 。

　　接口原型 :

　　boolean closeFile() ;

　　参数说明 :无 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　7.4 界面控制接口

　　7.4. 1 显示/隐藏组件

　　功能说明 :

　　设置阅读软件界面按钮或组件是否可见 。

　　接口原型 :

　　void setCompositeVisible(in string CompName,in boolean bVisible) ;参数说明(2个参数) :

　　参数 1:CompName 按钮或组件标识 ,见附录 C;

　　参数 2:bVisible 是否可见 ,true表示可见 ,false表示不可见 。

　　返回值说明 :无 。

　　7.4.2 启用/禁用组件

　　功能说明 :

　　设置工具栏或菜单栏中指定名称的按钮或菜单项是否可用 。

　　接口原型 :

　　public void setCompositeEnable (in string CompName,in boolean bEnable) ;参数说明(2个参数) :

　　参数 1:CompName 界面元素的标识 ,见附录 C;

　　参数 2:bEnable 是否可用 ,true表示可用 ,false表示不可用 。

　　返回值说明 :无 。

　　备注 :

　　如果是可控制界面元素列表之外的标识 ,不发生任何作用 。

　　7.4.3 设置视图首选项

　　功能说明 :

　　设置打开文档显示的视图首选项 ,参数组合见表 1。

　　接口原型 :

　　void setViewPreference(in string key,in string val) ;参数说明(2个参数) :

　　参数 1:key 表示首选项名称 ;

　　参数 2:val 表示首选项值 。

　　表 1 键值对应关系表

　　返回值说明 :无 。

　　7.4.4 设置页面显示比例

　　功能说明 :

　　设置页面显示比例 。

　　接口原型 :

　　void setZoomRadio(in floatzoomValue) ;参数说明(1个参数) :

　　参数 1:zoomValue 页面显示比例的值 ,例如 :120表示 120% 。返回值说明 :无 。

　　7.4.5 获取页面显示比例

　　功能说明 :

　　获取页面显示比例的值 。

　　接口原型 :

　　floatgetZoomRadio() ;

　　参数说明 :无 。

　　返回值说明 :

　　页面显示比例值 ,例如 :120表示 120% 。

　　7.5 信息设置接口

　　7.5. 1 设置用户名

　　功能说明 :

　　设置当前的用户名(用于注释和操作 日志) 。

　　接口原型 :

　　boolean setUserName(in string userName) ;参数说明(1个参数) :

　　参数 1:userName 用户名 。

　　返回值说明 :

　　true表示接口调用成功 ,false表示接口调用失败 。

　　7.5.2 获取用户名

　　功能说明 :

　　获取当前的用户名 。

　　接口原型 :

　　string getUserName() ;

　　参数说明 :无 。

　　返回值说明 :

　　用户名 。

　　7.5.3 设置印章标识

　　功能说明 :

　　设置将要应用的印章标识 。设置了此值后 ,将不能对当前文档应用与该标识不匹配的电子印章 ,此函数常用于配合用章授权 。

　　接口原型 :

　　void setSealId(in string sealId) ;参数说明(1个参数) :

　　参数 1:sealId印章的标识 。

　　返回值说明 :无 。

　　7.5.4 设置文档元数据

　　功能说明 :

　　为插件中的当前文档设置元数据 。插件未打开文档时调用无效 。

　　接口原型 :

　　void setMetaData(in string id,in string val) ;

　　参数说明(2个参数) :

　　参数 1:id 元数据的名称 ;

　　参数 2:val 元数据的值 。

　　返回值 :无 。

　　7.5.5 获取文档元数据

　　功能说明 :

　　获取为插件中的当前文档的元数据 。插件未打开文档时调用无效 。

　　接口原型 :

　　string getMetaData(in string id) ;参数说明(1个参数) :

　　参数 1:id 元数据的名称 。

　　返回值说明 :

　　元数据的值 。

　　7.5.6 设置日志服务地址

　　功能说明 :

　　为插件设置日 志 服 务 地 址,设 置 了 日 志 服 务 地 址 后 , 写 入 日 志 文 件 的 消 息 将 同 时 按 照 标 准HTTP协议写入日志服务。

　　接口原型 :

　　void setLogSvrURL(in string url) ;参数说明(1个参数) :

　　参数 1:url 日志服务地址 。

　　返回值说明 :无 。

　　7.6 设置水印

　　7.6. 1 添加追踪水印

　　功能说明 :

　　向插件中添加追踪信息 ,如水印 、份号等 ,该信息将用于显示或打印文档 。

　　接口原型 :

　　void addTrackInfo(in string xmlParam) ;参数说明(1个参数) :

　　参数 1:xmlParam 表示要添加水印的属性 。

　　返回值说明 :无 。

　　备注 :

　　水印信息格式见附录 E。

　　7.6.2 清除追踪水印

　　功能说明 :

　　清除插件中的水印信息 。

　　接口原型 :

　　void clearTrackInfo() ;

　　参数说明 :无 。

　　返回值说明 :无 。

　　7.7 获取语义内容

　　功能说明 :

　　从文档中获取指定名称的公文语义标引的内容 。插件未打开文档时调用无效 。

　　接口原型 :

　　string getTaggedText(in string tagId) ;参数说明(1个参数) :

　　参数 1:tagId 语义标引的唯一定位符 ,应符合文档内标引文件的实际结构 ,例如 “公文体/版头/密级 ”,见 GB/T 33476. 1—2016。

　　返回值说明 :

　　成功则返回公文语义标引的内容 ;失败则返回 null。

　　7. 8 获取日志文件路径

　　功能说明 :

　　此接口用于获取版式阅读软件日志文件路径 ,软件通过 日志文件 ,将内部操作(如打印 、签名 、验签等)进行记录和汇报 。

　　接口原型 :

　　string getLogFilePath() ;

　　参数说明 :无 。

　　返回值说明 :

　　成功则返回 日志文 件 的 路 径 , 如 “C:/Temps/reader. log”或 者 “/opt/reader. log”; 失 败 则 返 回null。

　　备注 :

　　日志文件格式见附录 F。

　　附 录 A

　　(规范性附录)

　　文字处理软件接口的 JavaScript形式

　　文字处理软件接口的 JavaScript形式如下 :

　　//6. 1 插件初始化

　　function init(vartagID,var width,var height){ . . . } //6. 2 获取插件版本

　　function getPluginVersion(){ . . . }

　　//6. 3. 1 创建空文件

　　function createDocument(var type){ . . . }

　　//6. 3. 2 打开本地文档

　　function openDocument(var fileName,var readOnly){ . . . }

　　//6. 3. 3 打开远程文档

　　function openDocumentRemote(var strURL,var readOnly){ . . . }

　　//6. 3. 4 保存到本地

　　function saveAs(var fileName){ . . . }

　　//6. 3. 5 保存到远程

　　function saveURL(var strURL,var fileName){ . . . } //6. 3. 6 打印

　　function print(){ . . . }

　　//6. 3. 7 打印/不打印修订内容

　　function printRevision(var status){ . . . } //6. 3. 8 关闭

　　function close(){ . . . }

　　//6. 4. 1 设置文档保护模式

　　function enableProtect(var bEnable){ . . . }

　　//6. 4. 2 显示/隐藏工具菜单

　　function setToolbarAllVisible(var bVisible){ . . . } //6. 4. 3 启用/禁用内容复制

　　function enableCopy(var bEnable){ . . . } //6. 4. 4 启用/禁用内容剪切

　　function enableCut(var bEnable){ . . . }

　　//6. 4. 5 开启/停止修订

　　function enableRevision(var bEnable){ . . . }

　　//6. 4. 6 设置页面显示比例

　　function setZoomRadio(var zoomValue){ . . . } //6. 4. 7 获取页面显示比例

　　function getZoomRadio(){ . . . }

　　//6. 4. 8 启用/停用组件

　　function setCompositeEnable(var CompName,var bEnable){ . . . }

　　//6. 5. 1 设置公文标识

　　function setDocumentId(var docid){ . . . } //6. 5. 2 获取公文标识

　　function getDocumentId(){ . . . } //6. 5. 3 设置公文文种

　　boolean setDocumentType(var documentType){ . . . } //6. 5. 4 获取公文文种

　　string getDocumentType(){ . . . }

　　//6. 5. 5 设置元数据

　　function setMetaData(varid,var val){ . . . } //6. 5. 6 获取元数据

　　function getMetaData(varid){ . . . } //6. 5. 7 插入图片

　　function insertPicture(var pictureFile,var left,var top,var width,var height){ . . . }

　　//6. 5. 8 提取全文文本function getText(){ . . . }

　　//6. 5. 9 退格操作

　　function backspace(){ . . . }

　　//6. 5. 10 插入文本

　　function insertText(var text){ . . . } //6. 6. 1 插入表格

　　function insertTable(var tableName,var columnCount,varrowCount){ . . . }

　　//6. 6. 2 删除表格

　　function removeTable(var tableName){ . . . } //6. 6. 3 设置表格的行高

　　function setRowHeight(var tableName,var num ,var height) { . . . }

　　//6. 6. 4 设置表格的列宽

　　function setColumnWidth (var tableName,var num ,var width) { . . . } //6. 6. 5 设置单元格保护属性

　　function setCellProtected(var tableName,varrow,var column,var isProtected) { . . . }

　　//6. 6. 6 光标定位单元格

　　public void cursorToCell(var tableName,varrow,var column) ; //6. 7. 1 启用/禁用接受修订按钮

　　function enableRevisionAcceptCommand(var bEnable){ . . . } //6. 7. 2 启用/禁用拒绝修订按钮

　　function enableRevisionRejectCommand(var bEnable){ . . . }

　　//6. 7. 3 设置修订痕迹的显示状态

　　function showRevision(var status){ . . . }

　　//6. 7. 4 设置用户名

　　function setUserName(var userName){ . . . } //6. 7. 5 获取用户名

　　function getUserName(){ . . . }

　　//6. 7. 6 按用户显示修订

　　function showRevisionAuthor(var author,var bShow){ . . . } //6. 7. 7 接受所有修订

　　function acceptAllChanges(){ . . . }

　　//6. 7. 8 拒绝所有修订

　　function rejectAllChanges(){ . . . }

　　//6. 7. 9 按用户接受修订

　　function filterCertainAuthor(var author,var bAccept){ . . . } //6. 8. 1 插入公文域

　　function insertDocumentField(varid){ . . . }

　　//6. 8. 2 设置公文域内容

　　function setDocumentField(varid,var val){ . . . }

　　//6. 8. 3 获取公文域列表

　　function getAllDocumentField(){ . . . }

　　//6. 8. 4 删除公文域

　　function deleteDocumentField(varid){ . . . }

　　//6. 8. 5 设置公文域是否显示

　　function showDocumentField(varid,var bVisible){ . . . } //6. 8. 6 获取公文域内容

　　function getDocumentFieldValue(varid){ . . . }

　　//6. 8. 7 设置公文域是否可编辑

　　function enableDocumentField(varid,var bEnable){ . . . }

　　//6. 8. 8 公文域插入文档内容

　　function insertDocument(varid,var fileName){ . . . }

　　//6. 8. 9 移动光标到公文域指定位置

　　function cursorToDocumentField(varid,var position){ . . . } //6. 9. 1 注册操作监听

　　function registListener(var operateId,var funcName,var bAfter){ . . . } //6. 9. 2 注销指定监听

　　function unRegistListener(var listenerId){ . . . }

　　附 录 B

　　(规范性附录)

　　版式阅读软件接口的 JavaScript形式

　　版式阅读软件接口的 JavaScript形式如下 :

　　//7. 1 插件初始化

　　function init(var divId,var width,var height){ . . . } //7. 2 获取插件版本

　　function getPluginVersion(){ . . . }

　　//7. 3. 1 打开文档

　　function openFile(var strURL,var readOnly){ . . . } //7. 3. 2 保存文档

　　function saveFile(var strURL){ . . . }

　　//7. 3. 3 打印文件

　　function printFile(var docName,var bGray){ . . . } //7. 3. 4 关闭文档

　　function closeFile(){ . . . }

　　//7. 4. 1 显示/隐藏组件

　　function setCompositeVisible(var CompName,var bVisible){ . . . }

　　//7. 4. 2 启用/禁用组件

　　function setCompositeEnable(var strCompName,var bEnable){ . . . } //7. 4. 3 设置视图首选项

　　function setViewPreference(var key,var val){ . . . } //7. 4. 4 设置页面显示比例

　　function setZoomRadio(var zoomValue){ . . . } //7. 4. 5 获取页面显示比例

　　function getZoomRadio(){ . . . }

　　//7. 5. 1 设置用户名

　　function setUserName(var userName){ . . . } //7. 5. 2 获取用户名

　　function getUserName(){ . . . }

　　//7. 5. 3 设置印章标识

　　function setSealId(var sealId){ . . . }

　　//7. 5. 4 设置文档元数据

　　function setMetaData(varid,var val){ . . . } //7. 5. 5 获取文档元数据

　　function getMetaData(varid){ . . . }

　　//7. 5. 6 设置日志服务地址

　　function setLogSvrURL(var url) { . . . }

　　//7. 6. 1 添加追踪水印

　　function addTrackInfo(var xmlParam){ . . . }

　　//7. 6. 2 清除追踪水印

　　function clearTrackInfo(){ . . . }

　　//7. 7 获取语义内容

　　function getTaggedText(vartagId){ . . . } //7. 8 获取日志文件路径

　　function getLogFilePath(){ . . . }

　　附 录 C

　　(规范性附录)软件的组件标识

　　软件的组件标识见表 C. 1。

　　表 C. 1 软件的组件标识

　　附 录 D

　　(规范性附录)

　　事件监听的消息名称

　　事件监听的消息名称见表 D. 1。

　　表 D. 1 事件监听的消息名称

　　附 录 E

　　(规范性附录)

　　水印信息的 XML模型

　　水印信息 XML模型如下 :

　　〈? xml version= "1.0" encoding= "UTF-8"?〉

　　〈xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"elementFormDefault="qualified" attributeFormDefault= " unqualified" Version= "1.0"〉

　　〈xs:element name= "setinfo"〉

　　〈xs:complexType〉

　　〈xs:sequence〉

　　〈xs:element name= "parameter" minOccurs= "0" maxOccurs= "unbounded"〉 〈xs:complexType〉

　　〈xs:simpleContent〉

　　〈xs:extensionbase= "xs:string"〉

　　〈xs:attributename="name" type="xs:string" use="required"/〉

　　〈xs:attribute name= "type" default= "string"〉

　　〈xs:simpleType〉

　　〈xs:restrictionbase= "xs:string"〉

　　〈xs:enumeration value= "boolean"/〉

　　〈xs:enumeration value= "int"/〉

　　〈xs:enumeration value= "float"/〉

　　〈xs:enumeration value= "string"/〉

　　〈xs:enumeration value= "datetime"/〉

　　〈xs:enumeration value= "base64"/〉 〈/xs:restriction〉

　　〈/xs:simpleType〉 〈/xs:attribute〉

　　〈xs:attribute name= "value" type= "xs:string"/〉 〈/xs:extension〉

　　〈/xs:simpleContent〉