Office控件

优道Office文档控件使用帮助

• 功能概述
• 运行环境
• 网页中嵌入控件
• 控件属性
• 控件方法
• 控件事件
• 其它

功能概述

优道Office文档控件（UUDoc Office Document Control）是一款简单易用的Office文档控件产品，能够在浏览器和桌面应用程序中直接编辑Word、Excel、PPT、WPS、金山电子表格等文档并保存到Web服务器当中。和其它的Office文档控件不同，本控件以简单易用为设计目标，只提供最常用的文档查看、编辑、保护锁定、痕迹控制、保存回服务器等功能，因此本控件可以做得尽可能的小巧和易用。

运行环境

服务器端：支持Windows和Linux操作系统，支持任何的服务器编程语言，例如asp,asp.net,php,java,python,ruby等

支持使用HTTP、HTTPS、FTP协议从服务器远程加载和保存文档，支持服务器身份验证

控件客户端支持的操作系统：WindowsXP/2003/2008/Vista/Win7/Win8

桌面开发支持的编程语言：VB、CSharp 、VB.NET、Delphi、C++等

支持32位及64位操作系统

支持嵌入到基于ActiveX技术的IE浏览器和桌面应用程序当中

网页中嵌入控件

您可以参考我们提供的演示文件在网页中嵌入优道Office文档控件：

控件的PlogId为:UdOffice.Control

控件的ClassId为:07100CA2-3057-4BFD-B79E-9439F3859D00

   
    <object id="udOfficeCtl" width="100%" height="600"
         classid="CLSID:07100CA2-3057-4BFD-B79E-9439F3859D00"
         codebase="UdOffice.ocx#version=2,3,0,0">
         <param name="Menubar" value="0" />    
         <param name="License" value="" />
    </object>

    

属性的设置示例：

   
    <script type="text/javascript">
        //根据复选框判断是否显示工具条
        function f_toolbars() {
            ctl.Toolbars = document.getElementById("chkToolbars").checked
        }
    </script>
    

方法的调用示例：

    <script type="text/javascript"> 
	//在线打开一个Excel文档
	function f_openXls() {
            ctl.OpenFromURL("sample.xls","xls");
        }
    </script>
    

事件的捕捉示例：

    <script type="text/javascript" event="OnDocumentOpened(file,doc)" for="udOfficeCtl">  
        document.getElementById("info").innerHTML = "OnDocumentOpened事件，文档已打开 "
    </script>
    

控件属性

属性名称	类型	属性说明
ActiveDocument	Object	获取当前活动文档对象，例如Word文档对象、Excel文档对象等
Toolbars	布尔	获取或设置是否显示Office工具条
ModalState	布尔	获取或设置控件是否处于模态状态
BorderStyle	整数	获取或设置控件的边框样式 0：无边框；1：扁平边框；2：3D模式边框；3：不太明显的3D边框
BorderColor	整数	获取或设置控件的边框颜色
BackColor	整数	获取或设置控件的背景色
ForeColor	整数	获取或设置控件的前景色
Menubar	布尔	获取或设置是否显示菜单栏
HostName	字符	获取或设置复合文档所嵌入到的的容器应用名称（宿主名）
DocumentFullName	字符	获取包含路径的文档文件全名
IsReadOnly	布尔	获取当前文档是否是以只读方式打开
IsDirty	布尔	获取文档是否已经被修改或需要进行保存
LockServer	布尔	获取或设置是否已锁定当前嵌入服务器以保持运行。
ActivationPolicy	整数	获取或设置文档激活方式 0：默认方式；1、应用未激活时保持激活状态；2：失去焦点时组件变成未激活状态；4：组件未激活时文档对象未激活
FrameHookPolicy	整数	获取或设置使用框架挂钩的方式，框架挂钩主要用于处理文档焦点的状态 0：正常方式；1：在第一次打开时设置；2：每次重新设置(Excel文档需要设置为这个）；-1：禁止使用挂钩
MenuAccelerators	布尔	获取或设置是否允许文档菜单合并到控件菜单栏中
EventsEnabled	布尔	获取或设置是否允许触发事件
DocumentName	字符	返回文档名称(不包括路径)
WebFileName	字符	获取或设置默认定义的文件名称（用于从程序读取文件有时并没有文件名的情况）
WebUserName	字符	获取或设置默认的文档用户名（记录到文档属性中的文档作者）
WebCodePage	整数	获取或设置字符编码所使用的代码页号，非UTF8编码时使用
IsUtf8Url	布尔	获取或设置是否使用UTF8编码的URL地址，否则按指定的代码页进行编码
IsUtf8Data	布尔	获取或设置是否使用UTF8编码格式进行数据传输，否则按指定的代码页进行编码。
AllowCopy	布尔	获取或设置是否允许复制文档内容
FileNew	布尔	获取或设置是否启用菜单及工具条中的“新建”功能
FileOpen	布尔	获取或设置是否启用菜单及工具条中的“打开”功能
FileClose	布尔	获取或设置是否启用菜单及工具条中的“关闭”功能
FileSave	布尔	获取或设置是否启用菜单及工具条中的“保存”功能
FileSaveAs	布尔	获取或设置是否启用菜单及工具条中的“另存为”功能
FilePrint	布尔	获取或设置是否启用菜单及工具条中的“打印”功能
FilePrintPreview	布尔	获取或设置是否启用菜单及工具条中的“打印预览”功能
FilePageSetup	布尔	获取或设置是否启用菜单或工具条中的“页面设置”
DocType	整数	获取控件中当前文档的类型： -1：未知；0：Doc；1：Docx,2：Docm,3：Xls；4：Xlsx；5：Xlsb；6：Xlsm； 7：Ppt；8：Pptx；9：Pptm；10：Vsd；11：Mpp；12：Wps；13：Et；14：Wpp
DocSize	整数	获取当前文档的字节数
OleAutoConvert	布尔	获取或设置是否自动进行OLE对象转换，可以防止调用其它软件造成问题
License	字符	获取或设置控件的注册码信息

控件方法

方法名称	参数说明	方法说明
void CreateNew(string progId)	progId：文档类型的标识符，可以用Word.Document、Excel.Sheet、PowerPoint.Slide等，这里也支持用文档的扩展名，例如doc、xls、ppt等	通过ProgId或文档文件扩展名来创建一个新的文档
void CreateFromTemplate( string template,string progId)	template：模板文件路径，支持本地文件和网络路径，支持相对路径 progId(可选)：文档的类型标识符，也支持文档扩展名	通过模版文件来创建一个新的文档
void OpenFromFile(string file, bool readOnly, string progId)	file：文档文件路径 readOnly(可选)：是否以只读方式打开，默认为false progId(可选)：文档类型的标识符或扩展名	从文件打开一个文档
void OpenFromURL(string url, string progId)	url：网络文件或服务器程序地址，支持相对路径方式 progId（可选）：文档类型的标识符或扩展名	从指定的URL打开一个文档
void SaveToFile(string file, bool overwrite)	file（可选）:要保存到的文件路径 overwrite（可选）：如果文件存在是否覆盖	保存文档到指定路径或它的原始位置
void SaveToURL(string url, string fileFieldName, string parameters, string fileName)	url：提交到的服务器处理程序地址 fileFieldName（可选）：提交使用的文件域名称，相当于表单中input的name值 parameters（可选）：以&分隔的附加参数，例如"name=abc&age=30" fileName（可选）：所提交文档的文件名称，相当于<input type="file" >选中的文件名	使用HTTP协议将文件保存到URL地址
void SetServerUser(string username, string password)	username：服务器身份验证的用户名 password：服务器用户登录密码	如果需要，设置服务器身份验证的用户名和密码
void Close()	无	关闭当前打开的文档
void ShowDialog(int dlgType)	dlgType：要显示的对话框类型： 0：新建；1：打开；2：保存；3：另存为；4：打印；5：页面设置；6：文档属性	显示一个用户指定操作类型的模态对话框。
void PrintOut(bool promptUser, string printerName, int copies, int fromPage, int toPage, string outputFile)	promptUser：是否提示用户 printerName：打印机名称 copies：打印份数 fromPage：打印起始页 toPage：打印终止页 outputFile：输出文件名称	使用指定的打印机及打印设置打印当前文档
void PrintPreview()	无	进入打印预览模式(要文档支持)
void PrintPreviewExit()	无	退出打印预览模式
void Protect(string password)	password(可选)：文档保护密码，为空使用随机密码	文档进入保护模式
void UnProtect(string password)	password(可选)：文档保护密码	文档退出保护模式
string GetVersion()	无	获取控件产品的当前版本号

备注：Progid 是在 (CLSID) 中使用的一个可读的版本的类标识符，用于标识 COM/ActiveX 对象，例如Word.Document、Excel.Sheet、PowerPoint.Slide等，为了方便使用，本控件也支持doc、docx、xls、xlsx、ppt、pptx等文件扩展名的使用方式

控件事件

事件名称	参数说明	事件说明
OnFileCommand(int item,bool cancel)	item：选择的菜单项： 0：新建；1：打开；2：关闭；3：保存；4：另存为； 5：打印；6：页面设置；7、文档属性；8：打印预览 cancel：为true取消执行	用户选择文件菜单后触发事件
OnDocumentOpened(string file,object document)	file：所打开的文件名 document：打开或创建的当前文档对象	打开或新建文档时触发事件
OnDocumentClosed()	无	文档关闭时触发事件
BeforeDocumentClosed(object document,bool cancel)	document：当前文档对象 cancel：为true时取消执行	文档关闭之前触发事件
OnActivationChange(bool fGoingActive)	fGoingActive：是否进入活动状态	组件获得或失去活动状态时触发事件
OnPrintPreviewExit()	无	打印预览关闭时触发事件
BeforeDocumentSaved(object document, string location,bool cancel)	document：当前文档对象 location：文档要保存到的路径名 cancel：为true时取消执行	文档保存之前触发事件
OnSaveCompleted(object document, string docName,string fullFileLocation)	document：当前文档对象 docName：文档名称 fullFileLocation：文档保存路径全名	文档保存成功时触发事件
OnDownload(long downloadSize,long totalSize)	downloadSize：当前已经下载的数据字节大小 totalSize：总共需要下载的文档字节大小	从服务器下载文档时触发事件
OnBeforePost(object document,bool cancel)	document：当前文档对象 cancel：为true时取消执行	文档提交服务器之前触发事件
OnPostCompleted(string responseText)	responseText：从服务器返回的文本信息	文档保存回服务器后触发事件

其它

• 关于优道：珠海市优道信息科技有限公司是一家致力于文档管理、数字版权保护和移动办公产品研发和推广的科技公司。
• 优道网站：www.uudoc.com
• 优道服务热线：0756-2132796，技术支持邮件：support@uudoc.com，技术支持QQ：13063574