ntko_office文档控件移动版开发接口参考v3.4.0

NTKO_OFFICE文档控件移动版开发接口参考V340在移动终端中使用OFFICE文档NTKOOFFICE文档控件移动版参考V30BUILD340更新时间2015年11月23日开发接重庆软航科技有限公司日期201511口第一章软件最终用户许可协议1第二章功能介绍（FEATURES）121功能简介122V30版本的新功能223详细功能列表224需要的软件325支持的WEB服务器3第三章集成步骤331导入AAR归档库（ANDROIDSTUDIO）332连接文档服务533构建JAVASCRIPTINTERFACE类634重写安卓ONDESTROY方法，销毁文档链接635WEB端获取的文件域标识7第四章主要属性参考741常用属性7411MSO_REVISE_MODE（已过时）7412DO_NOT_UPLOAD_IF_READONLY7413SOURCETYPE8第五章主要方法参考851连接文档服务9511CONNECT952参数设置相关方法9521SETDOCTYPE9522SETDOCUMENTTITLE10523SETDOCUMENTREMOTEADDRESS10524SETDOCUMENTUPLOADADDRESS10525SETDOCUMENTLOCALADDRESS11526SETUPLOADOPTIONS11527SETREVISEUSER11528SETDOCMODE12529SETOFFICEVERSION125210SETPDFREVISETOOLSVISIBILITY135211SETDOCUMENTUPLOADFAILEDRETRYTIMES135212FIELDSLISTADD135213SETCUSTOMFORMFIELDS1453打开OFFICE文件窗口UI设置相关方法14531GETSAVE14532GETSAVEAS14533GETPRINT15534GETSHARE1554新建、打开和保存文档相关方法15541CREATEWORD15542CREATEEXCEL15543CREATEPRESENTATION16544EDITWORD16545EDITEXCEL16546EDITPDFDOCUMENT16547EDITPRESENTATION17548OPENIMAGEFILE17549OPENXPSFILE17第六章JAVASCRIPT/JSCRIPT代码1861使用JAVASCRIPT与安卓应用程序交互18第七章常见问题（FAQS）1871如何输入产品密钥18第八章商标和权利声明1881关于本文提到的商标声明1882软航，NTKO商标说明19第一章软件最终用户许可协议重要须知请认真阅读本最终用户许可协议（以下称协议）是您（个人或单一实体）与我们之间有关NTKOOFFICE文档控件移动版软件产品的法律协议。本“软件产品”包括计算机软件，并可能包括相关媒体、印刷材料，和“联机”或电子文档（“软件产品”）。本“软件产品”还包括对我们提供给您的原“软件产品”的任何更新和补充资料。任何与本“软件产品”一同提供给您的并与单独一份最终用户许可证相关的软件产品是根据那份许可协议中的条款而授予您。您一旦安装、复制、下载、访问或以其它方式使用“软件产品”，即表示您同意接受本协议各项条款的约束。如您不同意本协议中的条款，请不要安装或使用“软件产品”。NTKOOFFICE文档控件移动版是受版权保护的。如果您得到的是未注册版本，您还没有获得运行授权。请在测试完成之后从您的机器中删除。如果您得到的是注册版本，您可以在授权协议许可的范围内使用本软件。您不能分发，销售，以及非法破解本软件。也不能超出协议许可的范围使用本软件。否则，将被视为侵犯了我们的知识产权。对反向工程REVERSEENGINEERING、反向编译DECOMPILATION、反汇编DISASSEMBLY的限制。您不得对本“软件产品”进行反向工程、反向编译DECOMPILE或反汇编DISASSEMBLE，但尽管有这项限制，如适用法律明示允许上述活动，则不在此限。另外，我们不对您在使用此软件的过程中对您的机器或者数据造成的损失负责。第二章功能介绍（FEATURES）21功能简介NTKOOFFICE文档控件移动版实现了在移动端和PC端以格式一致的展现方INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层式来阅读编辑OFFICE文档。通过调用移动编辑中间件提供的相关接口，可以非常容易的实现在移动平台上对办公文档的阅读和编辑。我们同时提供一套便利方法，可以打开OA及其它文档管理系统服务器上的文档，控制文档的审阅，对文档进行签批，并保存文档到远程服务器上，用户可以方便的集成到自己的移动OA系统中，和自己现有的移动产品集成在一起。可以运行在ANDROID41以上移动平台之中，支持常用OFFICE文档的编辑如WORD、EXCEL、PDF、POWERPOINT文件等。使用NTKOOFFICE文档控件移动版后，移动终端除安装我司提供的必要组件外，无须再安装其它移动OFFICE软件。我们提供了一套非常简洁的集成最佳实践，轻松搞定集成，使业务移动化，技术保障完备，提供原生、混合模式集成等多套解决方案，功能接口快速增长，涵盖多种使用场景。22V30版本的新功能新增支持打开XPS及图片文件；新增参数控制PDF签批笔款及颜色；新增查看同一PDF文件时记忆上次查看到的页数。23详细功能列表INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层使用NTKOOFFICE文档控件移动版，可以大大缩短整个系统的开发时间，降低系统的开发成本，提高产品的质量和用户体验。24需要的软件正确运行本软件需要移动终端为41以上操作系统，安装我司提供的客户端组件。25支持的WEB服务器支持所有的支持HTTP/11标准的WEB服务器。第三章集成步骤31导入AAR归档库（ANDROIDSTUDIO）ANDROIDSTUDIO自带了可以导入ARR归档库的功能，这里以AS开发平台为例，该归档库需要在JDK17或17以上版本运行，SDK的最小版本号为16，集成测试时应用包名最好是COMNTKOAPPOFFICE。为了适配不同CPU构架的移动设备，除了主要的归档库LIBRARYSUPPORTV3RELEASEAAR外，对于PDF文件的阅读，提供了支持不同CPU构架的归档库，可根据用户不同CPU构架制作不同的APP，当然也可以全部引入。在项目中，点击项目结构SDK，点击号，如下图所示INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层然后选择“IMPORTJAR/ARRPACKAGE”下一步选择ARR归档库的路径，如下图所示点击完成，按照以上步骤将需要的其余AAR库导入到项目中后，为主项目添加MODULEDEPENDENCY，选中导入的归档库即可，如下图所示INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层然后为主项目添加所需依赖库，这些依赖库也可通过下载后直接引用添加，如下图所示到这里所需的依赖就导入配置好了。32连接文档服务在安卓应用程序需要调用打开操作文档的ACTIVITY中的ONCREATE方法里调用DOCUMENTSAGENT类的连接方法连接文档服务。INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层33构建JAVASCRIPTINTERFACE类可在安卓应用程序中自建一个类调用类库提供的相应接口并设置参数，以下类中的如打开服务器文档方法OPENDOCFROMURL可自定，也可自定义参数数量，打开文件的相关变量如文件名、打开文件地址、保存文件地址都是通过PARAMS类中的相关方法和属性设置34重写安卓ONDESTROY方法，销毁文档链接INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层35WEB端获取的文件域标识上传文件到后台的处理程序中，移动端提交的文件的文件域标识为FILEUPLOAD。第四章主要属性参考NTKOOFFICE文档控件移动版所有属性调用的类为PARAMS，直接通过该类调用，在打开方法前设置。41常用属性411MSO_REVISE_MODE（已过时）说明布尔型；是否进入修订模式。语法设置PARAMSMSO_REVISE_MODETRUE|FALSE412DO_NOT_UPLOAD_IF_READONLY说明布尔型；设置文件以只读打开时，是否也需要上传到服务器。语法INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层设置PARAMSDO_NOT_UPLOAD_IF_READONLYFALSEFALSE文件以只读打开时，也会上传到服务器上；TRUE文件以只读打开时不上传到服务器。413SOURCETYPE说明实例化参数对象时需要设置该属性，标识新建、打开远程服务器或打开本地文件。语法设置PARAMSSOURCETYPELOCAL打开本地文件；PARAMSSOURCETYPEREMOTE打开远程服务器文件；PARAMSSOURCETYPENEW新建文件。第五章主要方法参考NTKOOFFICE文档控件移动版设置相关参数调用的类为PARAMS，实例化该类获取对象调用设置相关属性。与文档打开、新建或保存一起使用，在打开、新建或保存方法前调用在打开方法中设置相关属性，调用前需实例化该类获取对象，该对象中需要传参数根据调用的资源操作方式不同，传不同参数。打开移动终端本地文件实例化代码如下打开远程服务器上文件实例化代码如下INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层新建文件实例化代码如下51连接文档服务511CONNECT语法DOCUMENTSAGENTCONNECT启动文档服务的ACTIVITY,产品序列号例DOCUMENTSAGENTCONNECTTHIS,“12345678912345678“功能设置文件打开后临时文件的后缀。返回值无返回值52参数设置相关方法521SETDOCTYPE语法PARAMSSETDOCTYPEPARAMSDOC_TYPE_MSO功能设置文件打开后临时文件的后缀。返回值无返回值INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层522SETDOCUMENTTITLE语法PARAMSSETDOCUMENTTITLE“新建WORD文档“功能设置打开文件窗口中显示的文件名及保存文件名。返回值无返回值523SETDOCUMENTREMOTEADDRESS语法PARAMSSETDOCUMENTREMOTEADDRESSREMOTE_MSO_PATH功能设置打开文件的URL返回值无返回值524SETDOCUMENTUPLOADADDRESS语法PARAMSSETDOCUMENTUPLOADADDRESSREMOTE_UPLOAD_PATH功能设置上传文件URL。返回值无返回值INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层共22页525SETDOCUMENTLOCALADDRESS语法PARAMSSETDOCUMENTLOCALADDRESSENVIRONMENTGETEXTERNALSTORAGEDIRECTORYFILESEPARATOR“NTKOPDF“功能设置打开本地文件的文件路径。返回值无返回值526SETUPLOADOPTIONS语法SETUPLOADOPTIONSNEWUPLOADOPTIONSUPLOADOPTIONSACTIVATIONON_DOCUMENT_CLOSED,TRUE功能当禁用了工具栏的保存及另存为按钮后，调用该方法并设置为TRUE后，才能触发保存操作并保存文件到服务器。527SETREVISEUSER语法PARAMSSETREVISEUSER“NTKOUSER“功能设置打开WORD后的痕迹用户名。返回值无返回值INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层共22页528SETDOCMODE语法PARAMSSETDOCMODEPARAMSMSO_DOC_MODE_NORMAL功能设置文件打开后默认的读写模式。返回值无返回值529SETOFFICEVERSION语法PARAMSSETOFFICEVERSIONPARAMSOFFICEVERSIONLATEST功能设置打开文件后文件的后缀版本，03、07及以上版本OFFICE，设置成相应版本后缀后，文件上传到服务器上时，服务器接受到的文件就是设置的相应后缀的文件。返回值无返回值INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层共22页5210SETPDFREVISETOOLSVISIBILITY语法PARAMSSETPDFREVISETOOLSVISIBILITY0功能设置是否显示PDF文件阅读窗口工具栏。返回值无返回值5211SETDOCUMENTUPLOADFAILEDRETRYTIMES语法PARAMSSETDOCUMENTUPLOADFAILEDRETRYTIMES3功能设置文档上传失败重试次数。5212FIELDSLISTADD语法CUSTOMFIELDSFIELDSNEWCUSTOMFIELDSFIELDSFIELDSLISTADDNEWCUSTOMFIELDKEYPAIR“SENDFILETIME“,“2015422”KEY,VALUE键值对应。功能设置自定义表单数据。返回值INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层共22页无返回值5213SETCUSTOMFORMFIELDS语法PARAMSSETCUSTOMFORMFIELDSFIELDS功能设置自定义表单参数。返回值无返回值53打开OFFICE文件窗口UI设置相关方法NTKOOFFICE文档控件移动版设置打开OFFICE文件窗口相关方法调用的类为EDITTABLE，实例化该类获取对象调用设置相关属性。在调用打开文档方法前调用。531GETSAVE语法TABLEGETSAVESETENABLEFALSE功能启用或禁用保存按钮。TRUE为启用，FALSE为禁用。532GETSAVEAS语法TABLEGETSAVEASSETENABLEFALSEINTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层共22页功能启用或禁用工具栏另存为到本地的按钮。TRUE为启用，FALSE为禁用。533GETPRINT语法TABLEGETPRINTSETENABLEFALSE功能启用或禁用工具栏打印按钮。TRUE为启用，FALSE为禁用。534GETSHARE语法TABLEGETSHARESETENABLEFALSE功能启用或禁用工具栏分享按钮。TRUE为启用，FALSE为禁用54新建、打开和保存文档相关方法541CREATEWORD语法DOCUMENTSAGENTCREATEWORDPARAMS功能创建一个新WORD文档。返回值无返回值542CREATEEXCEL语法DOCUMENTSAGENTCREATEEXCELPARAMS功能INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层共22页创建一个新EXCLE表格返回值无返回值。543CREATEPRESENTATION语法DOCUMENTSAGENTCREATEPRESENTATIONPARAMS功能创建一个演示文稿544EDITWORD语法DOCUMENTSAGENTEDITWORDPARAMS功能查看或编辑WORD文件。545EDITEXCEL语法DOCUMENTSAGENTEDITEXCELPARAMS功能查看或编辑EXCEL文件。546EDITPDFDOCUMENT语法DOCUMENTSAGENTEDITPDFDOCUMENTPARAMS功能查看PDF文件。INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUNGE16JIANGNANAVENUECHONGQINGNANANDISTRICTNO7WAVESEXHIBITIONTEL8602362943208重庆市南岸区江南大道7号浪高会展国际广场B座韵阁16层共22页547EDITPRESENTATION语法DOCUMENTSAGENTEDITPRESENTATIONPARAMS功能编辑POWERPOINT演示文稿。548OPENIMAGEFILE语法DOCUMENTSAGENTOPENIMAGEFILEFILEURL,FILENAME,FILETYPE功能打开服务器上图片方法中第一个参数为文件下载的路径，第二个参数为文件名，第三个参数为图片类型，图片类型支持JPG、PNG、BMP、TIFF，文件类型参数说明如下549OPENXPSFILE语法DOCUMENTSAGENTOPENXPSFILEFILEURL,FILENAME功能打开服务器上XPS文件。INTERNETWWWNTKOCOMINTERNATIONALPLAZABBLOCKYUN