NTKOOFFICE文檔控件移動(dòng)版開發(fā)接口參考V3.4.01

?2013重慶軟航科技有限公司【保密】?2013重慶軟航科技有限公司【保密】在移動(dòng)終端中使用Office文檔！V2.0版開發(fā)接口重慶軟航科技有限公司日期：2015.11TOC\o"1-3"\h\z第一章 軟件最終用戶許可協(xié)議 頁軟件最終用戶許可協(xié)議重要須知━請(qǐng)認(rèn)真閱讀：本《最終用戶許可協(xié)議》（以下稱《協(xié)議》）是您（個(gè)人或單一實(shí)體）與我們之間有關(guān)NTKOOffice文檔控件移動(dòng)版軟件產(chǎn)品的法律協(xié)議。本“軟件產(chǎn)品”包括計(jì)算機(jī)軟件，并可能包括相關(guān)媒體、印刷材料，和“聯(lián)機(jī)”或電子文檔（“軟件產(chǎn)品”）。本“軟件產(chǎn)品”還包括對(duì)我們提供給您的原“軟件產(chǎn)品”的任何更新和補(bǔ)充資料。任何與本“軟件產(chǎn)品”一同提供給您的并與單獨(dú)一份最終用戶許可證相關(guān)的軟件產(chǎn)品是根據(jù)那份許可協(xié)議中的條款而授予您。您一旦安裝、復(fù)制、下載、訪問或以其它方式使用“軟件產(chǎn)品”，即表示您同意接受本《協(xié)議》各項(xiàng)條款的約束。如您不同意本《協(xié)議》中的條款，請(qǐng)不要安裝或使用“軟件產(chǎn)品”。NTKOOffice文檔控件移動(dòng)版是受版權(quán)保護(hù)的。如果您得到的是未注冊(cè)版本，您還沒有獲得運(yùn)行授權(quán)。請(qǐng)?jiān)跍y試完成之后從您的機(jī)器中刪除。如果您得到的是注冊(cè)版本，您可以在授權(quán)協(xié)議許可的范圍內(nèi)使用本軟件。您不能分發(fā)，銷售，以及非法破解本軟件。也不能超出協(xié)議許可的范圍使用本軟件。否則，將被視為侵犯了我們的知識(shí)產(chǎn)權(quán)。對(duì)反向工程(ReverseEngineering)、反向編譯(Decompilation)、反匯編(Disassembly)的限制。您不得對(duì)本“軟件產(chǎn)品”進(jìn)行反向工程、反向編譯(decompile)或反匯編(disassemble)，但盡管有這項(xiàng)限制，如適用法律明示允許上述活動(dòng)，則不在此限。另外，我們不對(duì)您在使用此軟件的過程中對(duì)您的機(jī)器或者數(shù)據(jù)造成的損失負(fù)責(zé)。功能介紹（Features）功能簡介NTKOOffice文檔控件移動(dòng)版實(shí)現(xiàn)了在移動(dòng)端和PC端以格式一致的展現(xiàn)方式來閱讀編輯OFFICE文檔。通過調(diào)用移動(dòng)編輯中間件提供的相關(guān)接口，可以非常容易的實(shí)現(xiàn)在移動(dòng)平臺(tái)上對(duì)辦公文檔的閱讀和編輯。我們同時(shí)提供一套便利方法，可以打開OA及其它文檔管理系統(tǒng)服務(wù)器上的文檔，控制文檔的審閱，對(duì)文檔進(jìn)行簽批，并保存文檔到遠(yuǎn)程服務(wù)器上，用戶可以方便的集成到自己的移動(dòng)OA系統(tǒng)中，和自己現(xiàn)有的移動(dòng)產(chǎn)品集成在一起?？梢赃\(yùn)行在Android4.1以上移動(dòng)平臺(tái)之中，支持常用OFFICE文檔的編輯如WORD、EXCEL、PDF、POWERPOINT文件等。使用NTKOOFFICE文檔控件移動(dòng)版后，移動(dòng)終端除安裝我司提供的必要組件外，無須再安裝其它移動(dòng)OFFICE軟件。我們提供了一套非常簡潔的集成最佳實(shí)踐，輕松搞定集成，使業(yè)務(wù)移動(dòng)化，技術(shù)保障完備，提供原生、混合模式集成等多套解決方案，功能接口快速增長，涵蓋多種使用場景。V3.0版本的新功能新增支持打開XPS及圖片文件；新增參數(shù)控制PDF簽批筆款及顏色；新增查看同一PDF文件時(shí)記憶上次查看到的頁數(shù)。詳細(xì)功能列表打開服務(wù)器上文檔打開服務(wù)器上文檔，支持Word、Excel、PPT、PDF、XPS、TIFF、圖片等文檔打開移動(dòng)終端設(shè)備上文檔支持打開移動(dòng)終端上的Word、Excel、PPT等文檔保存文檔到服務(wù)器支持將打開的文件保存到服務(wù)器痕跡保留可以通過編程，控制在線打開的文件默認(rèn)進(jìn)入留痕狀態(tài)。修訂用戶設(shè)置支持設(shè)置修訂用戶名只讀方式打開支持打開Word、Excel、PDF以只讀方式打開廣泛的操作系統(tǒng)，Web服務(wù)器，數(shù)據(jù)庫支持Web端支持Windows,Linux,Unix等各種操作系統(tǒng)；支持IIS，Domino，Websphere，Apache等所有后臺(tái)WEB服務(wù)器類型，支持Db2，Oracle，MySQL，SQLServer等各種常用數(shù)據(jù)庫。支持在提交編輯文檔的同時(shí)，提交表單的其它數(shù)據(jù)采用我們獨(dú)創(chuàng)的“智能提交”技術(shù)，讓您在提交編輯文檔的同時(shí)，提交表單的其它數(shù)據(jù)。這可以讓您更加快速的集成現(xiàn)有的應(yīng)用程序，或者創(chuàng)建新的應(yīng)用程序。支持簡潔高效的編程接口可使用Javascript及java代碼對(duì)組件進(jìn)行編程。使用NTKOOffice文檔控件移動(dòng)版，可以大大縮短整個(gè)系統(tǒng)的開發(fā)時(shí)間，降低系統(tǒng)的開發(fā)成本，提高產(chǎn)品的質(zhì)量和用戶體驗(yàn)。

……需要的軟件正確運(yùn)行本軟件需要移動(dòng)終端為4.1以上操作系統(tǒng)，安裝我司提供的客戶端組件。支持的Web服務(wù)器支持所有的支持HTTP/1.1標(biāo)準(zhǔn)的Web服務(wù)器。集成步驟導(dǎo)入aar歸檔庫（AndroidStudio）AndroidStudio自帶了可以導(dǎo)入arr歸檔庫的功能，這里以AS開發(fā)平臺(tái)為例，該歸檔庫需要在jdk1.7或1.7以上版本運(yùn)行，SDK的最小版本號(hào)為16，集成測試時(shí)應(yīng)用包名最好是com.ntko.app.office。為了適配不同CPU構(gòu)架的移動(dòng)設(shè)備，除了主要的歸檔庫library.support.v3-release.aar外，對(duì)于PDF文件的閱讀，提供了支持不同CPU構(gòu)架的歸檔庫，可根據(jù)用戶不同CPU構(gòu)架制作不同的app，當(dāng)然也可以全部引入。在項(xiàng)目中，點(diǎn)擊項(xiàng)目結(jié)構(gòu)->SDK，點(diǎn)擊+號(hào)，如下圖所示：然后選擇“Import.JAR/.ARRPackage”->下一步->選擇arr歸檔庫的路徑，如下圖所示：點(diǎn)擊完成，按照以上步驟將需要的其余aar庫導(dǎo)入到項(xiàng)目中后，為主項(xiàng)目添加Moduledependency，選中導(dǎo)入的歸檔庫即可，如下圖所示：然后為主項(xiàng)目添加所需依賴庫，這些依賴庫也可通過下載后直接引用添加，如下圖所示：到這里所需的依賴就導(dǎo)入配置好了。注意：async的jar包必須要用1.4.9或以上版本。連接文檔服務(wù)在安卓應(yīng)用程序需要調(diào)用打開操作文檔的Activity中的onCreate方法里調(diào)用DocumentsAgent類的連接方法連接文檔服務(wù)。protectedvoidonCreate(BundlesavedInstanceState){super.onCreate(savedInstanceState);setContentView(R.layout.main);DocumentsAgent.connect(this,"產(chǎn)品序列號(hào)");}構(gòu)建JavascriptInterface類可在安卓應(yīng)用程序中自建一個(gè)類調(diào)用類庫提供的相應(yīng)接口并設(shè)置參數(shù)，以下類中的如打開服務(wù)器文檔方法openDocFromUrl可自定，也可自定義參數(shù)數(shù)量，打開文件的相關(guān)變量如文件名、打開文件地址、保存文件地址都是通過Params類中的相關(guān)方法和屬性設(shè)置：publicclassMobileOfficeWebInterface{@JavascriptInterfacepublicvoidopenDocFromUrl(Stringfilename,StringdownUrl,StringuploadUrl){Paramsparams=newParams(Params.SourceType.REMOTE); params.setDocType(Params.DOC_TYPE_MSO);//設(shè)置臨時(shí)文件后綴params.setDocumentRemoteAddress(downUrl);//設(shè)置文件下載地址params.setDocumentUploadAddress(uploadUrl);//設(shè)置文件保存地址params.setDocumentTitle(filename);//設(shè)置打開文檔后顯示文件窗口上的文件名及保存后的文件名//read閱讀模式>Params.MSO_DOC_MODE_READ//edit編輯模式>Params.MSO_DOC_MODE_NORMAL//handwrite手寫模式>Params.MSO_DOC_MODE_SIGNATUREparams.setDocMode(Params.MSO_DOC_MODE_NORMAL);//設(shè)置文件讀寫模式Params.MSO_REVISE_MODE=true;//設(shè)置是否啟用修訂params.setReviseUser("ntkouser");//設(shè)置修訂用戶//CustomFieldsfields=newCustomFields();//自定義表單參數(shù)//fields.fieldsList.add(newCustomFieldKeyPair("%%Detach",filename));//添加表單參數(shù)key，value//fields.fieldsList.add(newCustomFieldKeyPair("__Click","0"));//params.setCustomFormFields(fields);//設(shè)置自定義表單參數(shù)DocumentsAgent.editWord(params);//調(diào)用類庫提供的打開word文件方法}}重寫安卓onDestroy方法，銷毀文檔鏈接@OverrideprotectedvoidonDestroy(){super.onDestroy();DocumentsAgent.destroy(this);}WEB端獲取的文件域標(biāo)識(shí)上傳文件到后臺(tái)的處理程序中，移動(dòng)端提交的文件的文件域標(biāo)識(shí)為fileUpload。if(item.getFieldName().equals("fileUpload")){Filefile=newFile(request.getRealPath("/files"),filename);FileOutputStreamfos=newFileOutputStream(file);longfileSize=Streams.copy(stream,fos,true);System.out.println("文檔大小"+fileSize+"");out.write("FileName:"+filename+"\nFileSize:"+fileSize+"bytes\nServerPath："+file.getPath());msg="保存成功!";}主要屬性參考NTKOOFFICE文檔控件移動(dòng)版所有屬性調(diào)用的類為Params，直接通過該類調(diào)用，在打開方法前設(shè)置。常用屬性MSO_REVISE_MODE（已過時(shí)）說明：布爾型；是否進(jìn)入修訂模式。語法：設(shè)置：Params.MSO_REVISE_MODE={true|false};DO_NOT_UPLOAD_IF_READONLY說明：布爾型；設(shè)置文件以只讀打開時(shí)，是否也需要上傳到服務(wù)器。語法：設(shè)置：Params.DO_NOT_UPLOAD_IF_READONLY=false;false：文件以只讀打開時(shí)，也會(huì)上傳到服務(wù)器上；true：文件以只讀打開時(shí)不上傳到服務(wù)器。SourceType說明：實(shí)例化參數(shù)對(duì)象時(shí)需要設(shè)置該屬性，標(biāo)識(shí)新建、打開遠(yuǎn)程服務(wù)器或打開本地文件。語法：設(shè)置：Params.SourceType.LOCAL打開本地文件；Params.SourceType.REMOTE打開遠(yuǎn)程服務(wù)器文件；Params.SourceType.NEW新建文件。主要方法參考NTKOOFFICE文檔控件移動(dòng)版設(shè)置相關(guān)參數(shù)調(diào)用的類為Params，實(shí)例化該類獲取對(duì)象調(diào)用設(shè)置相關(guān)屬性。與文檔打開、新建或保存一起使用，在打開、新建或保存方法前調(diào)用在打開方法中設(shè)置相關(guān)屬性，調(diào)用前需實(shí)例化該類獲取對(duì)象，該對(duì)象中需要傳參數(shù)根據(jù)調(diào)用的資源操作方式不同，傳不同參數(shù)。打開移動(dòng)終端本地文件實(shí)例化代碼如下：Paramsparams=newParams(Params.SourceType.LOCAL);打開遠(yuǎn)程服務(wù)器上文件實(shí)例化代碼如下：Paramsparams=newParams(Params.SourceType.REMOTE);新建文件實(shí)例化代碼如下：Paramsparams=newParams(Params.SourceType.NEW);連接文檔服務(wù)Connect語法：DocumentsAgent.connect(啟動(dòng)文檔服務(wù)的Activity,產(chǎn)品序列號(hào));例：DocumentsAgent.connect(this,"12345678912345678");功能：設(shè)置文件打開后臨時(shí)文件的后綴。返回值：無返回值啟動(dòng)文檔服務(wù)的Activity設(shè)置為OFFICE文件類型產(chǎn)品序列號(hào)String類型這里需要天雪的產(chǎn)品序列號(hào)為17位的。參數(shù)設(shè)置相關(guān)方法setDocType語法：params.setDocType(Params.DOC_TYPE_MSO);功能：設(shè)置文件打開后臨時(shí)文件的后綴。返回值：無返回值Params.DOC_TYPE_MSO設(shè)置為OFFICE文件類型Params.DOC_TYPE_PDF設(shè)置為PDF文件類型Params.DOC_TYPE_IMG設(shè)置為圖片文件類型Params.DOC_TYPE_XPS設(shè)置為XPS文件類型setDocumentTitle語法：params.setDocumentTitle("新建Word文檔");功能：設(shè)置打開文件窗口中顯示的文件名及保存文件名。返回值：無返回值setDocumentRemoteAddress語法：params.setDocumentRemoteAddress(REMOTE_MSO_PATH);功能：設(shè)置打開文件的URL返回值：無返回值注意：若為新建或打開本地文件不需要設(shè)置該參數(shù)。setDocumentUploadAddress語法：params.setDocumentUploadAddress(REMOTE_UPLOAD_PATH);功能：設(shè)置上傳文件URL。返回值：無返回值注意：如果不需要保存文件，該參數(shù)設(shè)置為空。setDocumentLocalAddress語法：params.setDocumentLocalAddress(Environment.getExternalStorageDirectory()+File.separator+"ntko.pdf");功能：設(shè)置打開本地文件的文件路徑。返回值：無返回值注意：此方法僅適用于設(shè)置打開本地文件的路徑。setUploadOptions語法：setUploadOptions(newUploadOptions(UploadOptions.Activation.ON_DOCUMENT_CLOSED,true))功能：當(dāng)禁用了工具欄的保存及另存為按鈕后，調(diào)用該方法并設(shè)置為true后，才能觸發(fā)保存操作并保存文件到服務(wù)器。setReviseUser語法：params.setReviseUser("ntkouser");功能：設(shè)置打開word后的痕跡用戶名。返回值：無返回值注意：此方法需結(jié)合MSO_REVISE_MODE該屬性使用，設(shè)置痕跡模式后才有作用，屬性設(shè)置見HYPERLINKMSO_REVISE_MODE。setDocMode語法：params.setDocMode(Params.MSO_DOC_MODE_NORMAL);功能：設(shè)置文件打開后默認(rèn)的讀寫模式。返回值：無返回值Params.MSO_DOC_MODE_NORMAL缺省編輯模式Params.MSO_DOC_MODE_READONLY只讀模式Params.MSO_DOC_MODE_SIGNATURE簽批模式注意：簽批功能只支持Word及PDF文檔。setOfficeVersion語法：params.setOfficeVersion(Params.OfficeVersion.LATEST);功能：設(shè)置打開文件后文件的后綴版本，03、07及以上版本office，設(shè)置成相應(yīng)版本后綴后，文件上傳到服務(wù)器上時(shí)，服務(wù)器接受到的文件就是設(shè)置的相應(yīng)后綴的文件。返回值：無返回值Params.OfficeVersion.LATEST設(shè)置文件后綴版本為2007及以上版本Params.OfficeVersion.COMPATIBLE缺省設(shè)置文件后綴版本為2003版本setPdfReviseToolsVisibility語法：params.setPdfReviseToolsVisibility(0);功能：設(shè)置是否顯示PDF文件閱讀窗口工具欄。返回值：無返回值0不顯示非0缺省顯示注意：該功能只PDF文檔。setDocumentUploadFailedRetryTimes語法：params.setDocumentUploadFailedRetryTimes(3);功能：設(shè)置文檔上傳失敗重試次數(shù)。fieldsList.add語法：CustomFieldsfields=newCustomFields();fields.fieldsList.add(newCustomFieldKeyPair("sendFileTime",“2015.4.22”));key,value鍵值對(duì)應(yīng)。功能：設(shè)置自定義表單數(shù)據(jù)。返回值：無返回值setCustomFormFields語法：params.setCustomFormFields(fields)功能：設(shè)置自定義表單參數(shù)。返回值：無返回值注意：該方法中的fields設(shè)置方法參考HYPERLINKfieldsList.add打開OFFICE文件窗口UI設(shè)置相關(guān)方法NTKOOFFICE文檔控件移動(dòng)版設(shè)置打開OFFICE文件窗口相關(guān)方法調(diào)用的類為EditTable，實(shí)例化該類獲取對(duì)象調(diào)用設(shè)置相關(guān)屬性。在調(diào)用打開文檔方法前調(diào)用。EditTabletable=newEditTable();……………………DocumentsAgent.sendUIParams(table);getSave語法：table.getSave().setEnable(false);功能：啟用或禁用保存按鈕。true為啟用，false為禁用。getSaveAs語法：table.getSaveAs().setEnable(false);功能：啟用或禁用工具欄另存為到本地的按鈕。true為啟用，false為禁用。getPrint語法：table.getPrint().setEnable(false);功能：啟用或禁用工具欄打印按鈕。true為啟用，false為禁用。getShare語法：table.getShare().setEnable(false);功能：啟用或禁用工具欄分享按鈕。true為啟用，false為禁用新建、打開和保存文檔相關(guān)方法createWord語法：DocumentsAgent.createWord(params);功能：創(chuàng)建一個(gè)新word文檔。返回值：無返回值createExcel語法：DocumentsAgent.createExcel(params);功能：創(chuàng)建一個(gè)新Excle表格返回值：無返回值。createPresentation語法：DocumentsAgent.createPresentation(params);功能：創(chuàng)建一個(gè)演示文稿e(cuò)ditWord語法：DocumentsAgent.editWord(params);功能：查看或編輯word文件。editExcel語法：DocumentsAgent.editExcel(params);功能：查看或編輯Excel文件。editPDFDocument語法：DocumentsAgent.editPDFDocument(params);功能：查看PDF文件。editPresentation語法：DocumentsAgent.editPresentation(params);功能：編輯PowerPoint演示文稿。openImageFile語法：DocumentsAgent.openImageFile(fileurl,filename,filetype);功