Appearance
新建、打开和保存文档相关方法
CreateNew
语法:
javascript
CreateNew(ProgId)
功能:
创建一个新文档对象。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
ProgId | 必选 | string | 文档类型 |
返回值:
无返回值
说明:
创建一个新文档对象。必须指定ProgID。
常用ProgID对照表:
文档类型 | ProgID |
---|---|
Word文档 | Word.Document |
PowerPoint幻灯片 | PowerPoint.Show |
Excel工作表 | Excel.Sheet |
Excel图表 | Excel.Chart |
Visio画图 | Visio.Drawing |
MS Project项目 | MSProject.Project |
WPS文字2003 | WPSFile.4.8001 |
WPS文字2005-2012(V8版本) | WPS.Document |
WPS文字2013(V9版本)及以上 | KWPS.Document |
WPS表格2003 | ET.Sheet.1.80.01.2001 |
WPS表格2005-2012(V8版本) | ET.WorkBook |
WPS表格2013(V9版本)及以上 | KET.WorkBook |
WPS演示2013(V9版本)及以上 | KWPP.Presentation |
永中OFFICE文档 | EIOffice.Document |
CAD文档 | Autocad.drawing |
使用示例:
javascript
// 创建新的Word文档
Obj.CreateNew("Word.Document");
// 创建新的Excel工作表
Obj.CreateNew("Excel.Sheet");
// 创建新的PowerPoint幻灯片
Obj.CreateNew("PowerPoint.Show");
// 创建新的WPS文档
Obj.CreateNew("KWPS.Document");
SaveToURL
语法:
javascript
SaveToURL(URL, FileFieldName, [CPARA], [FileName], [HTMLForm], [IsShowUI])
功能:
该函数使用HTTP协议将文件保存到URL。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
URL | 必选 | string | 处理后台保存的URL地址 |
FileFieldName | 必选 | string | 控件文件域名称 |
CPARA | 可选 | string | 可选参数 |
FileName | 可选 | string | 文件名 |
HTMLForm | 可选 | string | 智能提交的form表单ID名称 |
IsShowUI | 可选 | bool | 是否显示进度条 |
返回值:
提交URL之后从服务器返回的数据。
说明:
该函数使用HTTP协议将文件保存到URL。2.0及以后版本对该函数做了增强。通过增加一个可选参数HTMLForm来引入了我们独创的"智能提交"技术。
使用示例:
javascript
// 基本保存
var result = Obj.SaveToURL("/save.php", "docfile", "", "document.doc");
// 带参数保存
var result = Obj.SaveToURL("/save.php", "docfile", "type=word&user=admin", "document.doc");
// 智能提交保存
var result = Obj.SaveToURL("/save.php", "docfile", "", "document.doc", "myform");
// 不显示进度条
var result = Obj.SaveToURL("/save.php", "docfile", "", "document.doc", "", false);
参数编码处理:
javascript
// 处理特殊字符的编码函数
function encodeObjValue(value) {
var t;
t = value.replace(/%/g, "%25");
return t.replace(/&/g, "%26");
}
// 使用示例
var params = "key=thiskey&type=word&load=mywave";
var encodedParams = encodeObjValue(params);
var result = Obj.SaveToURL("/save.php", "docfile", encodedParams, "document.doc");
BeginOpenFromURL
语法:
javascript
BeginOpenFromURL(URL, [IsShowProgress], [ReadOnly], [ProgId])
功能:
以异步方式开始打开URL文档。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
URL | 必选 | string | 处理后台打开的URL地址 |
IsShowProgress | 可选 | bool | 是否显示进度条 |
ReadOnly | 可选 | bool | 是否只读打开 |
ProgId | 可选 | string | 文档类型 |
返回值:
无返回值
说明:
以异步方式开始打开URL文档。该方法执行完毕,控件将从URL下载指定文档并打开。下载完毕将触发AfterOpenFromURL事件。
注意: 在将老版本的OpenFromURL替换为BeginOpenFromURL的过程中,请注意参数个数的变化。以及请注意以前的OpenFromURL是同步执行的,也就是说,执行完毕OpenFromURL方法之后,文档已经打开,可以立即访问控件的ActiveDocument属性。而调用完毕BeginOpenFromURL方法之后,控件是开始下载文档,此时控件的ActiveDocument属性还不可用。应该将对ActiveDocument属性的访问放到AfterOpenFromURL事件或者OnDocumentOpened事件的处理代码中。
使用示例:
javascript
// 异步打开URL文档
Obj.BeginOpenFromURL("/document.doc");
// 异步打开URL文档,不显示进度条
Obj.BeginOpenFromURL("/document.doc", false);
// 异步打开URL文档,只读模式
Obj.BeginOpenFromURL("/document.doc", true, true);
// 异步打开URL文档,指定文档类型
Obj.BeginOpenFromURL("/document.doc", true, false, "Word.Document");
事件处理:
javascript
// 在AfterOpenFromURL事件中处理文档打开后的操作
<script language="JScript" for="TANGER_OCX" event="AfterOpenFromURL()">
// 文档打开完成后的处理
console.log("文档已成功打开");
// 可以在这里访问ActiveDocument属性
// Obj.ActiveDocument.ShowRevisions = false;
</script>
OpenFromURL
语法:
javascript
OpenFromURL(URL, [ReadOnly], [ProgId])
功能:
该函数使用HTTP协议从URL(同步)打开文件。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
URL | 必选 | string | 处理后台打开的URL地址 |
ReadOnly | 可选 | bool | 是否只读打开 |
ProgId | 可选 | string | 文档类型 |
返回值:
无返回值
说明:
URL可以是相对于控件所在的网页的相对URL或者是绝对URL。只要打开的URL返回一个正确的Office文档,而不管其扩展名是否正确,该函数都能够自动正确判断文档类型。
使用示例:
javascript
// 同步打开URL文档
Obj.OpenFromURL("/document.doc");
// 同步打开URL文档,只读模式
Obj.OpenFromURL("/document.doc", true);
// 同步打开URL文档,指定文档类型
Obj.OpenFromURL("/document.doc", false, "Word.Document");
// 打开后可以立即访问ActiveDocument
Obj.OpenFromURL("/document.doc");
Obj.ActiveDocument.ShowRevisions = false;
OpenLocalFile
语法:
javascript
OpenLocalFile(Document, [ReadOnly], [ProgId])
功能:
打开本地文件。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
Document | 必选 | string | 本地文档路径 |
ReadOnly | 可选 | bool | 是否只读打开 |
ProgId | 可选 | string | 文档类型 |
返回值:
无返回值
说明:
第一个参数Document必须是一个有效的文件磁盘路径。第二个参数ReadOnly只是禁止保存回本地而不是禁止修改编辑,设置为true时,保存时会弹出另存窗口。如果文件有正确的扩展名,第三个参数ProgID可以省略,否则,必须指定ProgID。
使用示例:
javascript
// 打开本地文件
Obj.OpenLocalFile("C:\\Documents\\document.doc");
// 打开本地文件,只读模式
Obj.OpenLocalFile("C:\\Documents\\document.doc", true);
// 打开本地文件,指定文档类型
Obj.OpenLocalFile("C:\\Documents\\document.doc", false, "Word.Document");
SaveToLocal
语法:
javascript
SaveToLocal([SaveAsDocument], [OverwriteExisting], [isPrompt])
功能:
将文件保存到本地。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
SaveAsDocument | 可选 | string | 保存到本地的文档路径 |
OverwriteExisting | 可选 | bool | 是否覆盖现文件 |
isPrompt | 可选 | bool | 是否提示用户选择 |
返回值:
无返回值
说明:
将文件保存到本地。两个参数都是可选的。如果缺少第一个参数,将保存到原位置;第二个参数缺省是FALSE,不覆盖现有文件。
使用示例:
javascript
// 保存到原位置
Obj.SaveToLocal();
// 保存到指定位置
Obj.SaveToLocal("C:\\Documents\\newdocument.doc");
// 保存到指定位置,覆盖现有文件
Obj.SaveToLocal("C:\\Documents\\newdocument.doc", true);
// 保存到指定位置,提示用户选择
Obj.SaveToLocal("C:\\Documents\\newdocument.doc", false, true);
格式转换相关方法
PublishAsHTMLToURL
语法:
javascript
PublishAsHTMLToURL(URL, FileFieldName, [CPARA], [FileName], [HTMLForm], [IsShowUI])
功能:
将文件保存成HTML文件到URL。
参数: 与SaveToURL方法相同
返回值:
提交URL之后从服务器返回的数据。
说明:
该函数和SaveToURL函数的参数及返回值含义完全一致。不同之处在于,FileName现在可能有多个值,包括HTML文件,相关的图片文件等等多个文件,但是都是包含在FileName域中。
注意: 此方法是PLUS版、企业版、平台版所有。
SaveAsHTMLFile
语法:
javascript
SaveAsHTMLFile(FileName, [PromptSelect])
功能:
将文档保存为HTML文件到本地。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
FileName | 必选 | string | 另存为HTML的文件名 |
PromptSelect | 可选 | bool | 是否提示用户选择 |
返回值:
无返回值
说明:
将文档保存为HTML文件到本地。参数FileName必须指定要保存为的HTML文件的本地全路径。
注意: 此方法是PLUS版、企业版、平台版所有。
SaveAsOtherFormatToURL
语法:
javascript
SaveAsOtherFormatToURL(saveformat, URL, FileFieldName, [CPARA], [FileName], [HTMLForm], [IsShowUI])
功能:
该方法用来将文档保存为其他格式的文件到指定的URL。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
saveformat | 必选 | long | 兼容格式文件类型 |
URL | 必选 | string | 处理后台保存的URL地址 |
FileFieldName | 必选 | string | 控件文件域名称 |
CPARA | 可选 | string | 可选参数 |
FileName | 可选 | string | 文件名 |
HTMLForm | 可选 | string | 智能提交的form表单ID名称 |
IsShowUI | 可选 | bool | 是否显示进度条 |
返回值:
提交URL之后从服务器返回的数据。
说明:
该方法用来将文档保存为其他格式的文件到指定的URL。除第一个参数之外,其他参数的格式以及返回值,和SaveToURL方法的参数一致。
Word文档保存格式:
值 | 格式 | 说明 |
---|---|---|
0 | Txt格式 | 纯文本格式 |
1 | MHT格式 | 需要OFFICE XP及以上版本 |
2 | XML格式 | 需要OFFICE 2003及以上版本 |
3 | RTF格式 | 富文本格式 |
4 | UnicodeText格式 | Unicode文本格式 |
5 | 兼容WORD文档格式 | 兼容格式 |
Excel文档保存格式:
值 | 格式 | 说明 |
---|---|---|
0 | Txt格式 | 纯文本格式 |
1 | MHT格式 | 需要OFFICE XP及以上版本 |
2 | XML格式 | 需要OFFICE 2003及以上版本 |
3 | CSV格式 | 逗号分隔值格式 |
4 | UnicodeText格式 | Unicode文本格式 |
5 | Excel7格式 | Excel 7格式 |
7 | Excel95格式 | Excel 95格式 |
PowerPoint文档保存格式:
值 | 格式 | 说明 |
---|---|---|
0 | GIF格式 | 图形交换格式 |
1 | MHT格式 | 需要OFFICE XP及以上版本 |
2 | JPG格式 | JPEG图像格式 |
3 | RTF格式 | 富文本格式 |
4 | PNG格式 | 便携式网络图形格式 |
注意: 此方法是增强版(V5.0.2.2及以上)、PLUS版、企业版、平台版所有。
SaveAsOtherFormatFile
语法:
javascript
SaveAsOtherFormatFile(saveformat, FileName, [PromptSelect])
功能:
该方法用来将文档保存为其他格式的文件到本地指定的文件全路径。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
saveformat | 必选 | long | 兼容格式文件类型 |
FileName | 必选 | string | 另存为文件名 |
PromptSelect | 可选 | bool | 是否提示用户选择 |
返回值:
无返回值
说明:
该方法用来将文档保存为其他格式的文件到本地指定的文件全路径。第一个参数的含义和SaveAsOtherFormatToURL的第一个参数含义一致。第二个参数FileName必须指定要保存为的文件的本地全路径。
注意: 此方法是增强版(V5.0.2.2及以上)、PLUS版、企业版、平台版所有。
PDF相关方法
SaveAsPDFFile
语法:
javascript
SaveAsPDFFile(FileName, [PromptSelect], [SheetName], [IsShowMsg], [IsUseSecurity], [OwnerPass], [IsPermitPrint], [IsPermitCopy])
功能:
将文档控件中的文档保存为PDF文件。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
FileName | 必选 | string | 另存到本地的路径及文件名 |
PromptSelect | 可选 | bool | 是否提示用户选择 |
SheetName | 可选 | string | EXCEL工作表名称 |
IsShowMsg | 可选 | bool | 保存成功是否显示提示 |
IsUseSecurity | 可选 | bool | 是否对PDF文件使用安全特性 |
OwnerPass | 可选 | string | PDF文件的所有者口令 |
IsPermitPrint | 可选 | bool | PDF文件是否可以被打印 |
IsPermitCopy | 可选 | bool | PDF文件是否可以被拷贝文本 |
返回值:
无返回值
说明:
将文档控件中的文档保存为PDF文件。
注意: 此功能需要安装特定软件。请从:http://www.pdfforge.org/products/pdfcreator/download 下载安装PDFCreator 1_2_3 版本。此方法是PLUS版、企业版、平台版所有。
PublishAsPDFToURL
语法:
javascript
PublishAsPDFToURL(URL, FileFieldName, [CPARA], [FileName], [HTMLForm], [SheetName], [IsShowUI], [IsShowMsg], [IsUseSecurity], [OwnerPass], [IsPermitPrint], [IsPermitCopy])
功能:
将文档控件中的文档转换为PDF文件并保存到URL。
参数: 与SaveToURL方法类似,增加了PDF相关参数
返回值:
无返回值
说明:
将文档控件中的文档转换为PDF文件并保存到URL。
注意: 此功能需要安装特定软件。请从:http://www.pdfforge.org/products/pdfcreator/download 下载安装PDFCreator 1_2_3 版本。此方法是PLUS版、企业版、平台版所有。
TIF相关方法
SaveAsTifFile
语法:
javascript
SaveAsTifFile(FileName, [PromptSelect], [SheetName], [IsShowMsg])
功能:
将文档控件中的文档保存为TIF文件。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
FileName | 必选 | string | 另存到本地的路径及文件名 |
PromptSelect | 可选 | bool | 是否提示用户选择 |
SheetName | 可选 | string | EXCEL工作表名称 |
IsShowMsg | 可选 | bool | 保存成功是否显示提示 |
返回值:
无返回值
说明:
将文档控件中的文档保存为TIF文件。
注意: 此功能需要安装特定软件。请从:http://www.pdfforge.org/products/pdfcreator/download 下载安装PDFCreator 1_2_3 版本。此方法是PLUS版、企业版、平台版所有。
PublishAsTifToURL
语法:
javascript
PublishAsTifToURL(URL, FileFieldName, [CPARA], [FileName], [HTMLForm], [SheetName], [IsShowUI], [IsShowMsg])
功能:
将文档控件中的文档转换为TIF文件并保存到URL。
参数: 与SaveToURL方法类似
返回值:
无返回值
说明:
将文档控件中的文档转换为TIF文件并保存到URL。
注意: 此功能需要安装特定软件。请从:http://www.pdfforge.org/products/pdfcreator/download 下载安装PDFCreator 1_2_3版本。此方法是PLUS版、企业版、平台版所有。
OFD相关方法
SaveAsOFDFile
语法:
javascript
SaveAsOFDFile(FileName, [PromptSelect])
功能:
将文档控件中的文档保存为OFD文件到本地。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
FileName | 必选 | string | 另存到本地的路径及文件名 |
PromptSelect | 可选 | bool | 是否提示用户选择 |
返回值:
无返回值
说明:
将文档控件中的文档保存为OFD文件到本地。
注意: 此功能需要安装支持另存为OFD的WPS。
SaveAsOFDToURL [已过时]
语法:
javascript
SaveAsOFDToURL(URL, FileFieldName, [CPARA], [FileName], [HTMLForm], [IsShowUI])
功能:
将文档控件中的文档转换为OFD文件并保存到URL。
说明:
如果您的控件是2021年2月1日后发布的产品,建议使用下面新增的PublishAsOFDToURL方法。
PublishAsOFDToURL
语法:
javascript
PublishAsOFDToURL(URL, FileFieldName, [CPARA], [FileName], [HTMLForm], [IsShowUI])
功能:
将文档控件中的文档转换为OFD文件并保存到URL。
说明:
此功能为2021年2月1日后发布的产品新增,以代替SaveAsOFDToURL方法,使得Windows版控件和Linux版控件保持相同接口代码。
数据库相关方法
OpenFromODBCds
语法:
javascript
OpenFromODBCds(dsName, selectSQL, username, password, [ReadOnly], [ProgId])
功能:
从ODBC数据源读取文档。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
dsName | 必选 | string | ODBC连接名称 |
selectSQL | 必选 | string | SQL语句字符串 |
username | 必选 | string | 数据库用户名 |
password | 必选 | string | 数据库连接密码 |
ReadOnly | 可选 | bool | 是否只读打开 |
ProgId | 可选 | string | 文档类型 |
返回值:
无返回值
说明:
从ODBC数据源读取文档。第二个参数是Select语句,必须返回唯一的二进制列。
使用示例:
javascript
// 从ODBC数据源读取文档
Obj.OpenFromODBCds("v23db", "select filedata from MyUploadTable where id=27", "", "");
SaveToODBCds
语法:
javascript
SaveToODBCds(dsName, selectSQL, username, password)
功能:
将文档写入到ODBC数据源。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
dsName | 必选 | string | ODBC连接名称 |
selectSQL | 必选 | string | SQL语句字符串 |
username | 必选 | string | 数据库用户名 |
password | 必选 | string | 数据库连接密码 |
返回值:
无返回值
说明:
写入ODBC数据源,第二个参数是带有唯一二进制列参数的Insert或者Update语句。
使用示例:
javascript
// 将文档保存到ODBC数据源
Obj.SaveToODBCds("v23db", "insert into MyUploadTable (filename,filesize,filedata) values ('newdoc.doc',19520,?)", "", "");
Base64相关方法
GetBase64Value
语法:
javascript
GetBase64Value([IsShowUI])
功能:
读取控件中文件数据的BASE64编码。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
IsShowUI | 可选 | bool | 是否显示进度框 |
返回值:
BASE64编码字符串。
说明:
读取控件中文件数据的BASE64编码。
使用示例:
javascript
// 获取Base64编码
var base64Data = Obj.GetBase64Value();
// 获取Base64编码,不显示进度框
var base64Data = Obj.GetBase64Value(false);
PutBase64Value
语法:
javascript
PutBase64Value(varValue, [ProgId])
功能:
设定控件中文件数据的BASE64编码。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
varValue | 必选 | string | Base64编码字符串 |
ProgId | 可选 | string | 是否强制指定文件类型 |
返回值:
无返回值
说明:
设定控件中文件数据的BASE64编码。
使用示例:
javascript
// 设置Base64编码
Obj.PutBase64Value(base64Data);
// 设置Base64编码,指定文档类型
Obj.PutBase64Value(base64Data, "Word.Document");
文件类型相关方法
DefaultAddFileTypes
语法:
javascript
DefaultAddFileTypes(bstrDescribe, bstrFilterName)
功能:
设置打开本地文件时过滤后缀。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
bstrDescribe | 必选 | string | 打开文件类型描述字符串 |
bstrFilterName | 必选 | string | 打开文件类型后缀名字符串 |
返回值:
无返回值
说明:
设置打开本地文件时过滤后缀。第一个参数代表类型说明,可以是任意字符串,如"DOC类型"、"EXCEL类型"等描述性文字;第二个参数代表类型字符串,如".doc",".xls;.xlsx;.xlsb"等,多个类型间用英文分号进行分隔。
注意: 当本方法与属性DefaultOpenDocType同时使用时,会以本方法设置的类型为准。
使用示例:
javascript
// 设置Word文档类型
Obj.DefaultAddFileTypes("Word文档", "*.doc;*.docx");
// 设置Excel文档类型
Obj.DefaultAddFileTypes("Excel文档", "*.xls;*.xlsx;*.xlsb");
// 设置PowerPoint文档类型
Obj.DefaultAddFileTypes("PowerPoint文档", "*.ppt;*.pptx");
文件操作相关方法
IsLocalFileExists
语法:
javascript
IsLocalFileExists(FileName)
功能:
判断客户端本机指定文件是否存在。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
FileName | 必选 | string | 文件路径 |
返回值:
布尔型;true代表存在,false代表不存在。
说明:
本方法可以与OpenLocalFile、SaveToLocal等操作本地文件的方法搭配使用,即可以先判断本地文件是否存在,再进行打开或保存。
使用示例:
javascript
// 检查文件是否存在
if (Obj.IsLocalFileExists("C:\\Documents\\document.doc")) {
console.log("文件存在");
Obj.OpenLocalFile("C:\\Documents\\document.doc");
} else {
console.log("文件不存在");
}
ReadTxtANSIFile
语法:
javascript
ReadTxtANSIFile(FileName)
功能:
获取指定的ANSI编码格式的TXT文件内容。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
FileName | 必选 | string | 本地Txt文件路径 |
返回值:
String字符型;TXT文件内容字符串。
说明:
本方法可以用来向WORD文档里导入TXT格式的文件。
使用示例:
javascript
// 读取TXT文件内容
var txtContent = Obj.ReadTxtANSIFile("C:\\Documents\\document.txt");
console.log("文件内容:", txtContent);
WriteTxtANSIFile
语法:
javascript
WriteTxtANSIFile(FileName, fileTxt)
功能:
在本地创建一个ANSI格式的TXT文件。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
FileName | 必选 | string | 本地Txt文件路径 |
fileTxt | 必选 | string | 文件内容字符串 |
返回值:
无返回值。
说明:
本方法用于将指定的字符串(文字内容)写到本地生成TXT文件。
使用示例:
javascript
// 创建TXT文件
Obj.WriteTxtANSIFile("C:\\Documents\\newdocument.txt", "这是文件内容");
驱动器相关方法
GetDrivesCount
语法:
javascript
GetDrivesCount()
功能:
获取本地逻辑驱动器数量。
返回值:
数值型。
说明:
可用于结合保存到本地的方法应用。
GetDriveType
语法:
javascript
GetDriveType(Index)
功能:
获取指定序号的逻辑驱动器类型。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
Index | 必选 | long | 逻辑驱动器序号 |
返回值:
数值型。
驱动器类型对照表:
值 | 类型 | 说明 |
---|---|---|
2 | 可移动存储设备驱动器 | 如USB驱动器 |
3 | 本地存储设备驱动器 | 如硬盘驱动器 |
5 | 光盘驱动器 | 如CD/DVD驱动器 |
说明:
可用于结合保存到本地的方法应用。
GetDriveName
语法:
javascript
GetDriveName(Index)
功能:
获取指定序号的逻辑驱动器盘符名称。
参数:
名称 | 必选/可选 | 数据类型 | 说明 |
---|---|---|---|
Index | 必选 | long | 逻辑驱动器序号 |
返回值:
String字符串型。
说明:
可用于结合保存到本地的方法应用。
综合使用示例:
javascript
// 遍历所有驱动器并保存到D盘
for (var i = 0; i < Obj.GetDrivesCount(); i++) {
if (Obj.GetDriveType(i) == 3) { // 本地存储设备驱动器
var drivename = Obj.GetDriveName(i).toUpperCase();
if (drivename.indexOf("D") >= 0) {
// 判定存在盘符为D的硬盘驱动器
Obj.SaveToLocal(drivename + "1.docx");
}
}
}
方法分类总结
分类 | 方法 | 功能 | 版本要求 |
---|---|---|---|
新建文档 | CreateNew | 创建新文档 | 所有版本 |
打开文档 | BeginOpenFromURL | 异步打开URL文档 | 所有版本 |
OpenFromURL | 同步打开URL文档 | 所有版本 | |
OpenLocalFile | 打开本地文件 | 所有版本 | |
OpenFromODBCds | 从ODBC数据源读取文档 | 所有版本 | |
保存文档 | SaveToURL | 保存到URL | 所有版本 |
SaveToLocal | 保存到本地 | 所有版本 | |
SaveToODBCds | 保存到ODBC数据源 | 所有版本 | |
格式转换 | PublishAsHTMLToURL | 保存为HTML到URL | PLUS版+ |
SaveAsHTMLFile | 保存为HTML到本地 | PLUS版+ | |
SaveAsOtherFormatToURL | 保存为其他格式到URL | 增强版+ | |
SaveAsOtherFormatFile | 保存为其他格式到本地 | 增强版+ | |
PDF转换 | SaveAsPDFFile | 保存为PDF到本地 | PLUS版+ |
PublishAsPDFToURL | 保存为PDF到URL | PLUS版+ | |
TIF转换 | SaveAsTifFile | 保存为TIF到本地 | PLUS版+ |
PublishAsTifToURL | 保存为TIF到URL | PLUS版+ | |
OFD转换 | SaveAsOFDFile | 保存为OFD到本地 | 所有版本 |
PublishAsOFDToURL | 保存为OFD到URL | 2021年2月1日后 | |
Base64操作 | GetBase64Value | 获取Base64编码 | 所有版本 |
PutBase64Value | 设置Base64编码 | 所有版本 | |
文件操作 | IsLocalFileExists | 检查文件是否存在 | 所有版本 |
ReadTxtANSIFile | 读取TXT文件 | 所有版本 | |
WriteTxtANSIFile | 写入TXT文件 | 所有版本 | |
驱动器操作 | GetDrivesCount | 获取驱动器数量 | 所有版本 |
GetDriveType | 获取驱动器类型 | 所有版本 | |
GetDriveName | 获取驱动器名称 | 所有版本 | |
文件类型 | DefaultAddFileTypes | 设置文件类型过滤 | 所有版本 |
使用流程
1. 文档创建流程
javascript
// 创建新文档
function createNewDocument() {
try {
// 创建新的Word文档
Obj.CreateNew("Word.Document");
console.log("新文档创建成功");
} catch (error) {
console.error("创建文档失败:", error.message);
}
}
2. 文档打开流程
javascript
// 打开文档
function openDocument() {
try {
// 同步打开URL文档
Obj.OpenFromURL("/document.doc");
console.log("文档打开成功");
// 可以立即访问ActiveDocument
Obj.ActiveDocument.ShowRevisions = false;
} catch (error) {
console.error("打开文档失败:", error.message);
}
}
// 异步打开文档
function openDocumentAsync() {
try {
// 异步打开URL文档
Obj.BeginOpenFromURL("/document.doc");
console.log("开始下载文档");
} catch (error) {
console.error("开始下载文档失败:", error.message);
}
}
3. 文档保存流程
javascript
// 保存文档
function saveDocument() {
try {
// 保存到URL
var result = Obj.SaveToURL("/save.php", "docfile", "", "document.doc");
console.log("文档保存成功:", result);
} catch (error) {
console.error("保存文档失败:", error.message);
}
}
注意事项
- 版本兼容性:不同版本支持的方法不同,请根据实际版本选择合适的方法
- 异步处理:BeginOpenFromURL是异步方法,需要在事件中处理文档打开后的操作
- 文件路径:本地文件路径必须是有效的磁盘路径
- 网络连接:URL相关方法需要网络连接
- 权限设置:某些方法需要特定的权限设置
- 错误处理:实现完善的错误处理机制
- 性能考虑:大文件操作时注意性能影响
错误处理
javascript
// 文档操作错误处理
function handleDocumentError(operation, error) {
console.error("文档操作失败:", operation, error.message);
// 根据错误类型进行相应处理
switch(operation) {
case 'CreateNew':
console.log("创建文档失败,请检查ProgID是否正确");
break;
case 'OpenFromURL':
console.log("打开URL文档失败,请检查网络连接和URL地址");
break;
case 'SaveToURL':
console.log("保存到URL失败,请检查服务器状态");
break;
case 'OpenLocalFile':
console.log("打开本地文件失败,请检查文件路径");
break;
default:
console.log("未知操作失败");
}
}
最佳实践
- 版本选择:根据实际需求选择合适的版本和方法
- 错误处理:实现完善的错误处理机制
- 性能优化:大文件操作时使用异步方法
- 用户体验:提供清晰的操作反馈
- 兼容性测试:在不同环境下测试各种方法
- 文档管理:合理管理文档的创建、打开和保存流程