NTKO_OFFICE文档控件移动版开发接口参考V3.4.0

1、2013重庆软航科技有限公司 【保密】在移动终端中使用OFFICE文档！V2.0版NTKO OFFICE文档控件移动版参考V3.0 Build 3.4.0更新时间：2015年11月23日开发接口重庆软航科技有限公司 日期：2015.11第一章软件最终用户许可协议1第二章功能介绍（Features）12.1功能简介12.2V3.0版本的新功能22.3详细功能列表22.4需要的软件32.5支持的Web服务器3第三章集成步骤33.1导入aar归档库（Android Studio）33.2连接文档服务53.3构建JavascriptInterface类63.4重写安卓onDestroy方法，销毁文档链

2、接63.5WEB端获取的文件域标识7第四章主要属性参考74.1常用属性74.1.1MSO_REVISE_MODE（已过时）74.1.2DO_NOT_UPLOAD_IF_READONLY74.1.3SourceType8第五章主要方法参考85.1连接文档服务95.1.1Connect95.2参数设置相关方法95.2.1setDocType95.2.2setDocumentTitle105.2.3setDocumentRemoteAddress105.2.4setDocumentUploadAddress105.2.5setDocumentLocalAddress115.2.6setUploadO

3、ptions115.2.7setReviseUser115.2.8setDocMode125.2.9setOfficeVersion125.2.10setPdfReviseToolsVisibility135.2.11setDocumentUploadFailedRetryTimes135.2.12fieldsList.add135.2.13setCustomFormFields145.3打开OFFICE文件窗口UI设置相关方法145.3.1getSave145.3.2getSaveAs145.3.3getPrint155.3.4getShare155.4新建、打开和保存文档相关方法155.4

4、.1createWord155.4.2createExcel155.4.3createPresentation165.4.4editWord165.4.5editExcel165.4.6editPDFDocument165.4.7editPresentation175.4.8openImageFile175.4.9openXPSFile17第六章JavaScript/Jscript代码186.1使用JavaScript与安卓应用程序交互18第七章常见问题（FAQs）187.1如何输入产品密钥？18第八章商标和权利声明188.1关于本文提到的商标声明188.2软航， NTKO商标说明19 第一章

5、 软件最终用户许可协议重要须知 请认真阅读：本最终用户许可协议（以下称协议）是您（个人或单一实体）与 我们之间有关NTKO Office文档控件移动版软件产品的法律协议。本“软件产品”包括计算机软件，并可能包括相关媒体、印刷材料，和“联机”或电子文档（“软件产品”）。本“软件产品”还包括对我们提供给您的原“软件产品”的任何更新和补充资料。任何与本“软件产品”一同提供给您的并与单独一份最终用户许可证相关的软件产品是根据那份许可协议中的条款而授予您。您一旦安装、复制、下载、访问或以其它方式使用“软件产品”，即表示您同意接受本协议各项条款的约束。如您不同意本协议中的条款，请不要安装或使用“软件产品”

6、。NTKO Office文档控件移动版是受版权保护的。如果您得到的是未注册版本，您还没有获得运行授权。请在测试完成之后从您的机器中删除。如果您得到的是注册版本，您可以在授权协议许可的范围内使用本软件。您不能分发，销售，以及非法破解本软件。也不能超出协议许可的范围使用本软件。否则，将被视为侵犯了我们的知识产权。对反向工程 (Reverse Engineering)、反向编译 (Decompilation)、反汇编 (Disassembly) 的限制。您不得对本“软件产品”进行反向工程、反向编译 (decompile) 或反汇编 (disassemble)，但尽管有这项限制，如适用法律明示允许上述

7、活动，则不在此限。另外，我们不对您在使用此软件的过程中对您的机器或者数据造成的损失负责。第二章 功能介绍（Features）2.1 功能简介NTKO Office 文档控件移动版实现了在移动端和 PC 端以格式一致的展现方式来阅读编辑 OFFICE 文档。通过调用移动编辑中间件提供的相关接口，可以非常容易的实现在移动平台上对办公文档的阅读和编辑。我们同时提供一套便利方法，可以打开 OA 及其它文档管理系统服务器上的文档，控制文档的审阅，对文档进行签批，并保存文档到远程服务器上， 用户可以方便的集成到自己的移动 OA 系统中，和自己现有的移动产品集成在一起。可以运行在 Android4.1 以上

8、移动平台之中，支持常用 OFFICE 文档的编辑如 WORD、EXCEL、PDF、POWERPOINT文件等。使用 NTKO OFFICE 文档控件移动版后，移动终端除安装我司提供的必要组件外，无须再安装其它移动 OFFICE 软件。我们提供了一套非常简洁的集成最佳实践，轻松搞定集成，使业务移动化，技术保障完备，提供原生、混合模式集成等多套解决方案，功能接口快速增长，涵盖多种使用场景。2.2 V3.0版本的新功能1 新增支持打开XPS及图片文件；1 新增参数控制PDF签批笔款及颜色；1 新增查看同一PDF文件时记忆上次查看到的页数。2.3 详细功能列表打开服务器上文档打开服务器上文档，支持Wo

9、rd、Excel、PPT、PDF、XPS、TIFF、图片等文档打开移动终端设备上文档支持打开移动终端上的Word、Excel、PPT等文档保存文档到服务器支持将打开的文件保存到服务器痕迹保留可以通过编程，控制在线打开的文件默认进入留痕状态。修订用户设置支持设置修订用户名只读方式打开支持打开Word、Excel、PDF以只读方式打开广泛的操作系统，Web服务器，数据库支持Web端支持Windows,Linux,Unix等各种操作系统；支持IIS，Domino，Websphere，Apache等所有后台WEB服务器类型，支持Db2，Oracle，MySQL，SQL Server等各种常用数据库。支

10、持在提交编辑文档的同时，提交表单的其它数据采用我们独创的“智能提交”技术，让您在提交编辑文档的同时，提交表单的其它数据。这可以让您更加快速的集成现有的应用程序，或者创建新的应用程序。支持简洁高效的编程接口可使用Javascript及java代码对组件进行编程。使用NTKO Office文档控件移动版，可以大大缩短整个系统的开发时间，降低系统的开发成本，提高产品的质量和用户体验。  2.4 需要的软件正确运行本软件需要移动终端为4.1以上操作系统，安装我司提供的客户端组件。2.5 支持的Web服务器支持所有的支持HTTP/1.1标准的Web服务器。第三章 集成步骤3.1 导入aar归档

11、库（Android Studio）Android Studio自带了可以导入arr归档库的功能，这里以AS开发平台为例，该归档库需要在jdk1.7或1.7以上版本运行，SDK的最小版本号为16，集成测试时应用包名最好是com.ntko.app.office。为了适配不同CPU构架的移动设备，除了主要的归档库library.support.v3-release.aar外，对于PDF文件的阅读，提供了支持不同CPU构架的归档库，可根据用户不同CPU构架制作不同的app，当然也可以全部引入。在项目中，点击项目结构->SDK，点击+号，如下图所示：然后选择“Import .JAR/.ARR Pa

12、ckage”->下一步->选择arr归档库的路径，如下图所示：点击完成，按照以上步骤将需要的其余aar库导入到项目中后，为主项目添加Module dependency，选中导入的归档库即可，如下图所示：然后为主项目添加所需依赖库，这些依赖库也可通过下载后直接引用添加，如下图所示：到这里所需的依赖就导入配置好了。$ 注意：async的jar包必须要用1.4.9或以上版本。3.2 连接文档服务在安卓应用程序需要调用打开操作文档的Activity中的onCreate方法里调用DocumentsAgent类的连接方法连接文档服务。protected void onCreate(Bundle

13、 savedInstanceState) super.onCreate(savedInstanceState); setContentView(R.layout.main); DocumentsAgent.connect(this, "产品序列号");3.3 构建JavascriptInterface类可在安卓应用程序中自建一个类调用类库提供的相应接口并设置参数，以下类中的如打开服务器文档方法openDocFromUrl可自定，也可自定义参数数量，打开文件的相关变量如文件名、打开文件地址、保存文件地址都是通过Params类中的相关方法和属性设置：public class M

14、obileOfficeWebInterface JavascriptInterface public void openDocFromUrl(String filename,String downUrl,String uploadUrl) Params params = new Params(Params.SourceType.REMOTE);params.setDocType(Params.DOC_TYPE_MSO);/设置临时文件后缀 params.setDocumentRemoteAddress(downUrl);/设置文件下载地址 params.setDocumentUploadAdd

15、ress(uploadUrl);/设置文件保存地址 params.setDocumentTitle(filename);/设置打开文档后显示文件窗口上的文件名及保存后的文件名 / read 阅读模式 -> Params.MSO_DOC_MODE_READ / edit 编辑模式 -> Params.MSO_DOC_MODE_NORMAL / handwrite 手写模式 -> Params.MSO_DOC_MODE_SIGNATURE params.setDocMode(Params.MSO_DOC_MODE_NORMAL);/设置文件读写模式 Params.MSO_REVI

16、SE_MODE = true;/设置是否启用修订 params.setReviseUser("ntkouser");/设置修订用户 /CustomFields fields = new CustomFields();/自定义表单参数 /fields.fieldsList.add(new CustomFieldKeyPair("%Detach", filename);/添加表单参数 key，value /fields.fieldsList.add(new CustomFieldKeyPair("_Click", "0"

17、;); /params.setCustomFormFields(fields);/设置自定义表单参数 DocumentsAgent.editWord(params);/调用类库提供的打开word文件方法 3.4 重写安卓onDestroy方法，销毁文档链接 Override protected void onDestroy() super.onDestroy(); DocumentsAgent.destroy(this); 3.5 WEB端获取的文件域标识上传文件到后台的处理程序中，移动端提交的文件的文件域标识为fileUpload。if(item.getFieldName().equals(

18、"fileUpload") File file = new File(request.getRealPath("/files"), filename); FileOutputStream fos = new FileOutputStream(file); long fileSize = Streams.copy(stream, fos, true); System.out.println("-文档大小 "+fileSize+"-"); out.write("File Name:" + filen

19、ame + "nFile Size:" + fileSize + " bytesnServer Path：" + file.getPath(); msg = "保存成功!"第四章 主要属性参考NTKO OFFICE文档控件移动版所有属性调用的类为Params，直接通过该类调用，在打开方法前设置。4.1 常用属性4.1.1 MSO_REVISE_MODE（已过时）说明：布尔型；是否进入修订模式。语法：设置：Params. MSO_REVISE_MODE = true|false;4.1.2 DO_NOT_UPLOAD_IF_READON

20、LY说明：布尔型；设置文件以只读打开时，是否也需要上传到服务器。语法：设置：Params.DO_NOT_UPLOAD_IF_READONLY = false;false：文件以只读打开时，也会上传到服务器上；true：文件以只读打开时不上传到服务器。4.1.3 SourceType说明：实例化参数对象时需要设置该属性，标识新建、打开远程服务器或打开本地文件。语法：设置：Params. SourceType.LOCAL 打开本地文件；Params. SourceType. REMOTE 打开远程服务器文件；Params. SourceType.NEW 新建文件。第五章 主要方法参考NTKO OF

21、FICE文档控件移动版设置相关参数调用的类为Params，实例化该类获取对象调用设置相关属性。与文档打开、新建或保存一起使用，在打开、新建或保存方法前调用在打开方法中设置相关属性，调用前需实例化该类获取对象，该对象中需要传参数根据调用的资源操作方式不同，传不同参数。打开移动终端本地文件实例化代码如下：Params params = new Params(Params.SourceType.LOCAL);打开远程服务器上文件实例化代码如下：Params params = new Params(Params.SourceType.REMOTE);新建文件实例化代码如下：Params params

22、= new Params(Params.SourceType.NEW);第一章5.1 连接文档服务5.1.1 Connect语法：DocumentsAgent.connect(启动文档服务的Activity, 产品序列号);例：DocumentsAgent.connect(this, "12345678912345678");功能：设置文件打开后临时文件的后缀。返回值：无返回值启动文档服务的Activity设置为OFFICE文件类型产品序列号String类型$ 这里需要天雪的产品序列号为17位的。5.2 参数设置相关方法5.2.1 setDocType语法：params.

23、setDocType (Params.DOC_TYPE_MSO);功能：设置文件打开后临时文件的后缀。返回值：无返回值Params.DOC_TYPE_MSO设置为OFFICE文件类型Params.DOC_TYPE_PDF设置为PDF文件类型Params.DOC_TYPE_IMG设置为图片文件类型Params.DOC_TYPE_XPS设置为XPS文件类型5.2.2 setDocumentTitle语法：params.setDocumentTitle("新建Word文档");功能：设置打开文件窗口中显示的文件名及保存文件名。返回值：无返回值5.2.3 setDocumentRe

24、moteAddress语法：params.setDocumentRemoteAddress(REMOTE_MSO_PATH);功能：设置打开文件的URL返回值：无返回值$ 注意：若为新建或打开本地文件不需要设置该参数。5.2.4 setDocumentUploadAddress语法：params.setDocumentUploadAddress(REMOTE_UPLOAD_PATH);功能：设置上传文件URL。返回值：无返回值$ 注意：如果不需要保存文件，该参数设置为空。5.2.5 setDocumentLocalAddress语法：params.setDocumentLocalAddress

25、(Environment.getExternalStorageDirectory() + File.separator + "ntko.pdf");功能：设置打开本地文件的文件路径。返回值：无返回值$ 注意：此方法仅适用于设置打开本地文件的路径。5.2.6 setUploadOptions语法：setUploadOptions(new UploadOptions(UploadOptions.Activation.ON_DOCUMENT_CLOSED, true)功能：当禁用了工具栏的保存及另存为按钮后，调用该方法并设置为true后，才能触发保存操作并保存文件到服务器。5.2

26、.7 setReviseUser语法：params.setReviseUser("ntkouser");功能：设置打开word后的痕迹用户名。返回值：无返回值$ 注意：此方法需结合MSO_REVISE_MODE该属性使用，设置痕迹模式后才有作用，属性设置见MSO_REVISE_MODE。5.2.8 setDocMode语法：params.setDocMode(Params. MSO_DOC_MODE_NORMAL);功能：设置文件打开后默认的读写模式。返回值：无返回值 Params. MSO_DOC_MODE_NORMAL缺省编辑模式Params. MSO_DOC_MODE

27、_READONLY只读模式Params.MSO_DOC_MODE_SIGNATURE签批模式$ 注意：签批功能只支持Word及PDF文档。5.2.9 setOfficeVersion语法：params. setOfficeVersion(Params.OfficeVersion.LATEST);功能：设置打开文件后文件的后缀版本，03、07及以上版本office，设置成相应版本后缀后，文件上传到服务器上时，服务器接受到的文件就是设置的相应后缀的文件。返回值：无返回值 Params.OfficeVersion.LATEST设置文件后缀版本为2007及以上版本Params.OfficeVersio

28、n.COMPATIBLE缺省设置文件后缀版本为2003版本5.2.10 setPdfReviseToolsVisibility语法：params.setPdfReviseToolsVisibility(0);功能：设置是否显示PDF文件阅读窗口工具栏。返回值：无返回值 0不显示非0缺省显示$ 注意：该功能只PDF文档。5.2.11 setDocumentUploadFailedRetryTimes语法：params.setDocumentUploadFailedRetryTimes(3);功能：设置文档上传失败重试次数。5.2.12 fieldsList.add语法：CustomFields

29、fields = new CustomFields();fields.fieldsList.add(new CustomFieldKeyPair("sendFileTime", “2015.4.22”);key,value 键值对应。功能：设置自定义表单数据。返回值：无返回值5.2.13 setCustomFormFields语法：params.setCustomFormFields(fields)功能：设置自定义表单参数。返回值：无返回值$ 注意：该方法中的fields设置方法参考fieldsList.add5.3 打开OFFICE文件窗口UI设置相关方法NTKO OFF

30、ICE文档控件移动版设置打开OFFICE文件窗口相关方法调用的类为EditTable，实例化该类获取对象调用设置相关属性。在调用打开文档方法前调用。EditTable table = new EditTable();DocumentsAgent.sendUIParams(table);5.3.1 getSave语法：table.getSave().setEnable(false);功能：启用或禁用保存按钮。true为启用，false为禁用。5.3.2 getSaveAs语法：table.getSaveAs().setEnable(false);功能：启用或禁用工具栏另存为到本地的按钮。true

31、为启用，false为禁用。5.3.3 getPrint语法：table.getPrint().setEnable(false);功能：启用或禁用工具栏打印按钮。true为启用，false为禁用。5.3.4 getShare语法：table.getShare().setEnable(false);功能：启用或禁用工具栏分享按钮。true为启用，false为禁用5.4 新建、打开和保存文档相关方法5.4.1 createWord语法：DocumentsAgent.createWord(params);功能：创建一个新word文档。返回值：无返回值5.4.2 createExcel语法：Docume

32、ntsAgent.createExcel(params);功能：创建一个新Excle表格返回值：无返回值。5.4.3 createPresentation语法：DocumentsAgent.createPresentation(params);功能：创建一个演示文稿5.4.4 editWord语法：DocumentsAgent.editWord(params);功能：查看或编辑word文件。5.4.5 editExcel 语法：DocumentsAgent.editExcel(params);功能：查看或编辑Excel文件。5.4.6 editPDFDocument语法：DocumentsAg

33、ent.editPDFDocument(params);功能：查看PDF文件。5.4.7 editPresentation语法：DocumentsAgent. editPresentation (params);功能：编辑PowerPoint演示文稿。5.4.8 openImageFile语法：DocumentsAgent. openImageFile (fileurl, filename, filetype);功能：打开服务器上图片方法中第一个参数为文件下载的路径，第二个参数为文件名，第三个参数为图片类型，图片类型支持JPG、PNG、BMP、TIFF，文件类型参数说明如下：Params.ImageFileType.BMP打开BMP格式图片Params.ImageFileType. JPG打开JPG格式图片Params.ImageFileType. PNG打开PNG格式图片Para