1、WebOffice开发文档WebOffice 文档控件开发文档标记 名称:WebOffice开发文档状态:发布部门:研发部文档ID:WebOffice-01-001 一、工作原理WebOffice是基于客户端的ocx控件，它的功能是将Office文档（Word、Excel、WPS）嵌入到浏览器中，并调用Office中各种接口，完成文档编辑工作，然后使用控件的Http接口模拟表单提交，发送到数据处理页面（此文档举例为saveDoc.asp页，代码见演示文件），完成文档的存档工作。1.1 开发流程 装载控件 . 触发初始化方法 执行初始化方法，打开新文档或装载已经存在的文档function Web
2、Office1_NotifyCtrlReady() document.all.WebOffice1.LoadOriginalFile(, ); 根据当前步骤，来决定是否进入修订状态，如果是修订状态，最好设置当前的用户名function WebOffice1_NotifyCtrlReady() document.all.WebOffice1.LoadOriginalFile(, ); document.all.WebOffice1.SetCurrUserName(张三); document.all.WebOffice1.SetTrackRevisions(1); 填写表单元素，编辑Office文
3、档 执行Http上传接口保存表单元素和Office文档 /保存文档之前，如果需要接受修订，需要调用document.all.WebOffice1.SetTrackRevisions(4); /通过Http接口上传document.all.WebOffice1.HttpInit(); document.all.WebOffice1.HttpAddPostString(, );document.all.WebOffice1.HttpAddPostCurrFile(, ); document.all.WebOffice1.HttpPost() saveDoc.asp获取表单数据和Office进行数据
4、库操作，并返回操作是否正确。 根据saveDoc.asp返回值进行相应操作。1.2 WEB页面调用控件: 主要参数说明：id 控件在网页的别名，可以通过别名调用控件的方法、属性width 控件的宽度，可以使用绝对大小，如width=100px。height 控件的高度codebase 设置控件自动下载的路径，用户如果没有安装控件，系统会自动访问codebase的路径下载控件；“#Version”后的是控件的版本，如果用户当前的软件版本低于“#Version”后面的版本，系统也会自动下载最新的控件注意： 如果控件的width 和height属性使用表示，则要明确指明它所在的容器的大小，如把控件放
5、到表格内，则要明确指明表格的width和height的绝对值。二、接口说明2.1 接口2.1.1 AboutBox原 型: void AboutBox();功 能：显示WebOffice版本信息返回值： 示 例：document.all.WebOffice1. AboutBox();2.1.2 AcceptAllRevisions原 型: long AcceptAllRevisions();功 能：接受当前文档所有修订 返回值：0：接受修订成功 非零：接受修订失败示 例：document.all.WebOffice1.AcceptAllRevisions();2.1.3 AddMenu原 形：
6、AddMenu(LPCTSTR cMenuName, LPCTSTR cChildName, long iIndex, LPCTSTR cBindJSFun)功 能：（保留）参 数：返回值：示 例： 2.1.4 BookMarkOpt原 型: long BookMarkOpt(BSTR strBookMarks,long lType);功 能：获取文档书签列表(保留)参 数： 返回值:示 例： 2.1.5 CloseDoc原 型: long CloseDoc(long blReqSaved);功 能：关闭当前文档参 数： blReqSaved: 0：关闭文档，不保存当前修改。 1：关闭文档，保
7、存当前修改。 2：如果文档已经被修改,显示保存文档对话框,否则直接关闭。 其它：关闭文档，保存当前修改。返回值: 0： 失败 非零： 成功示 例： /关闭当前文档，不保存当前修改。document.all.WebOffice1.CloseDoc (0);2.1.6 ConvertToAip原 型: short ConvertToAip(short nAddOriFile,short nSupport)功 能：把当前通过LoadOriginalFile打开的原始文件直接转化成AIP文件。参 数：nAddOriFile:是否装载原始文件。0：不装载。非0：装载原始文件。 nSupport:是否以普
8、通方式（即解析文档的书签）打开。0：不解析。非0：解析。返回值：0：转化失败 非零：转化成功示 例：document.all.WebOffice1.ConvertToAip (1，1)；2.1.7 CreateApp原 型: short CreateApp(BSTR strAppName);功 能：（保留）参 数： 返回值: 示 例： 2.1.8 DelLocalFile原 型: long DelLocalFile(BSTR strFilePathName);功 能：删除本地文件（6.0.4.0以后的版本，只能删除临时文件，即通过GetTempFilePath获取的路径）参 数： strFil
9、ePathName：本地文件的绝对路径。返回值: 0： 删除成功 非零： 删除失败示 例： document.all.WebOffice1.DelLocalFile(c:111.doc);2.1.9 DownLoadFile原 型: short DownLoadFile(LPCTSTR strHttpFileURL, LPCTSTR strLocalFilePath, LPCTSTR strTitle, LPCTSTR strFileType)功 能：下载远程服务器文件，当设置OptionFlag |= 0x0080 会弹出文件下载进度条。参 数： strHttpFileURL：服务器文件路径
10、。strLocalFilePath：保存的本地文件路径，如为空则弹出文件保存对话框。strTitle：文件保存对话框的默认文件名，仅当strLocalFilePath为空有效。strFileType：默认文件类型，仅当strLocalFilePath为空有效。返回值: 0： 成功 非零： 失败示 例：obj.DownLoadFile(,c:111.sel,);obj.DownLoadFile(,标题,doc);2.1.10 ExcProtectSharing原 型: long ExcProtectSharing(BSTR strPassword,BSTR strWriteResPassword
11、, short bReadOnlyRecommended,BSTR strSharingPassword);功 能：(保留)参 数：返回值: 示 例：2.1.11 ExcUnprotectSharing原 型: long ExcUnprotectSharing(BSTR strSharingPassword);功 能：(保留)参 数：返回值: 示 例：2.1.12 FtpConnect原 型: long FtpConnect(BSTR strURL, long lPort, BSTR strUser, BSTR strPwd); 功 能：FTP相关(保留)参 数： 返回值:示 例： 2.1.1
12、3 FtpDisConnect原 型: long FtpDisConnect();功 能：FTP相关(保留)参 数： 返回值:示 例： 2.1.14 FtpGetFile原 型: long FtpGetFile(BSTR strRemoteFile, BSTR strLocalFile);功 能：FTP相关(保留)参 数： 返回值:示 例： 2.1.15 GetDocumentObject原 型: IDispatch* GetDocumentObject();功 能：获取文档对象的ActiveDocument对象，此接口非常重要，基本所有的VBA功能都可以通过这个接口来实现。参 数： 返回值:
13、 ActiveDocument对象的Dispatch示 例：/* 以下的JavaScript为采用ActiveDocument的方式直接操作VBA，向DOC文档的书签中加入一个图片。function AddPicture(strMarkName,strBmpPath,vType)在书签位置插入图片,strMarkName 书签的名称strBmpPath 图片的路径vType 插入后的图片的样式，5为浮动在文字上面AddPicture(test1,d:111.bmp,5);AddPicture(test1,d:111.bmp,128);*/function AddPicture(strMarkN
14、ame,strBmpPath,vType)/定义一个对象，用来存储ActiveDocument对象 var obj; obj = new Object(document.all.WebOffice1.GetDocumentObject(); if(obj !=null) var pBookMarks;/ VAB接口获取书签集合 pBookMarks = obj.Bookmarks; var pBookM;/ VAB接口获取书签strMarkName pBookM = pBookMarks(strMarkName); var pRange;/ VAB接口获取书签strMarkName的Range
15、对象 pRange = pBookM.Range; var pRangeInlines; / VAB接口获取书签strMarkName的Range对象的InlineShapes对象 pRangeInlines = pRange.InlineShapes; var pRangeInline; / VAB接口通过InlineShapes对象向文档中插入图片 pRangeInline = pRangeInlines.AddPicture(strBmpPath); /设置图片的样式，5为浮动在文字上面 pRangeInline.ConvertToShape().WrapFormat.TYPE = vT
16、ype; delete obj;2.1.16 GetFieldValue原 型: BSTR GetFieldValue(BSTR strFieldName, BSTR strSheetName);功 能：获得书签位置的数值参 数：strFieldName：书签的名字strSheetName：预留字段（值为空） 返回值: 返回书签的值示 例：/获得书签的值 var strFieldValue=document.all.WebOffice1.GetFieldValue(mark_1,)2.1.17 GetTempFilePath原 型: BSTR GetTempFilePath();功 能：获得临
17、时文件路径参 数： 返回值: 当前文件的临时路径示 例： var strTempPath=document.all.WebOffice1.GetTempFilePath ()；2.1.18 GetRevCount原 型: long GetRevCount();功 能：获取修订节点的个数参 数： 返回值: 获取修订节点的个数示 例：2.1.19 GetRevInfo原 型: BSTR GetRevInfo(long lIndex, long lType);功 能：获取修订节点的信息（修订人，修订的时间，修订的动作）参 数： lIndex: 修订的节点编号 lType: 获取的信息编号 返回值:示
18、 例：/1.获取修订的用户vUserName = document.all.WebOffice1.GetRevInfo(i,0); /2.获取修订的时间vDate = new String(document.all.WebOffice1.GetRevInfo(i,1);/3.获取修订的动作var vRet = document.all.WebOffice1.GetRevInfo(i,2);vRet = 1:表示插入的操作vRet = 2:表示删除的操作 /4.获取修订的内容vUserName = document.all.WebOffice1.GetRevInfo(i,3);/总体的例子代码v
19、ar vCount;vCount = document.all.WebOffice1.GetRevCount(); var vOpt = 0;var vDate;for(var i=1; i= vCount; i+) vOpt = document.all.WebOffice1.GetRevInfo(i,2); if(1 = vOpt) vOpt = 插入; else if(2 = vOpt) vOpt = 删除; else vOpt = 未知操作; vDate = new String(document.all.WebOffice1.GetRevInfo(i,1); vDate = pars
20、eFloat(vDate); dateObj = new Date(vDate); alert(dateObj.getYear() + 年 + dateObj.getMonth() + 1 + 月 + dateObj.getDate() +日 + dateObj.getHours() +时 + dateObj.getMinutes() +分 + dateObj.getSeconds() +秒 ); alert(用户:+document.all.WebOffice1.GetRevInfo(i,0) + rn操作: + vOpt + rn内容: + document.all.WebOffice1.
21、GetRevInfo(i,3);2.1.20 GetFileSize原 型: long GetFileSize (LPCTSTR strFilePath);功 能：获取本地文件的大小参 数： 返回值:示 例： var vLen = obj.GetFileSize(c:111.doc);2.1.21 GetBookMarkCount原 型: long GetBookMarkCount();功 能：获取文档中书签的总数量参 数： 返回值:示 例： GetFileSize2.1.22 GetBookMarkInfo原 型: BSTR GetBookMarkInfo(long lIndex, long
22、 lType);功 能：获取各书签的信息（名称和变量）参 数： 返回值:示 例： var vBKCount; vBKCount = document.all.WebOffice1.GetBookMarkCount(); var iIndex; var vName; var vValue; var vShowInfo; vShowInfo = ; for(iIndex = 1; iIndex = vBKCount; iIndex+) vName = document.all.WebOffice1.GetBookMarkInfo(iIndex,0 ); vValue = document.all.
23、WebOffice1.GetBookMarkInfo(iIndex,1 ); vShowInfo += BK+iIndex+:+vName+=+vValue+; vName = ; vValue = ; alert(vShowInfo);2.1.23 HideMenuItem 原 型: long HideMenuItem(long lMenuType);功 能：控制自有工具栏的显示参 数：lMenuType工具栏开关，采用32位的数字作为开关，当相关位为1的时候，按钮显示，为0是按钮隐藏。enum vNew = 0x01, /新建 vOpen = 0x02, /打开 vSaveAs = 0x0
24、4, /保存 vPrint = 0x10, /打印 vPrintView = 0x20, /打印预览 vReturn = 0x1000, /全屏 vFullScrean = 0x2000 /返回;返回值:示 例： /只显示新建和全屏按钮Object.HideMenuItem(0x01 + 0x1000);2.1.24 HideMenuAction原 型: long HideMenuAction(short shMenuMode, long lValue);功 能：设置菜单的隐藏和显示。支持Office2007的菜单隐藏和显示参 数：(仅适用于Office2007)shMenuMode：设置模式
25、：具体值及含义如下：0：Office2003以下，直接关闭菜单，暂未支持。可使用SetToolBarButton2接口控制 1：Office2007以上，需要设置关闭菜单列表 2：扩展值，暂无含义 3：扩展值，暂无含义 4：扩展值，暂无含义5：设置关闭菜单列表后，需调用此值激活。并第二个参数设置为0，具体见示例。 6：恢复菜单显示及功能使用，第二个参数设置为0lValue:设置要隐藏的菜单及禁止复制、粘贴功能 0x1000：十进制为4096-粘贴无效 0x2000：十进制为8192复制无效 0x100000：十进制为1048576开始菜单0x200000：十进制为2097152插入菜单0x40
26、0000：十进制为4194304页面布局菜单0x800000：十进制为8388608引用菜单0x1000000：十进制为16777216邮件菜单0x2000000：十进制为33554432审阅菜单0x4000000：十进制为67108864视图菜单0x8000000：十进制为134217728开发工具菜单0x10000000：十进制为268435456加载项菜单返回值： 示 例：/设置粘贴无效document.all.WebOffice1. HideMenuAction(1,4096);/设置动作document.all.WebOffice1. HideMenuAction(5,0);/激活设
27、置/设置复制无效document.all.WebOffice1. HideMenuAction(1,4096);document.all.WebOffice1. HideMenuAction(5,0);/设置开始菜单隐藏document.all.WebOffice1. HideMenuAction(1,1048576);document.all.WebOffice1. HideMenuAction(5,0);/设置多菜单隐藏（比如隐藏开始、插入、页面布局菜单）document.all.WebOffice1. HideMenuAction(1,1048576+2097152+4194304);document.all.WebOffice1. HideMenuAction(5,0);
