Home > SYS_FileManager > getDocumentFile

SYS_FileManager.getDocumentFile() method

获取文档文件

签名

function getDocumentFile(
	fileName?: string,
	password?: string,
	fileType?: 'epro' | 'epro2',
): Promise<File | undefined>;

参数名

参数	类型	描述
fileName	string	（可选） 文件名
password	string	（可选） 加密密码
fileType	'epro' | 'epro2'	（可选） 文件格式

返回值

Promise<File | undefined>

文档文件数据，undefined 表示当前未打开文档或数据获取失败

备注

可以使用 SYS_FileSystem.saveFile() 接口将文件导出到本地文件系统

注意：本接口需要启用 **工程设计图 > 文件导出** 权限，没有权限调用将始终 throw Error

示例

// 1. 导出当前文档为文件（文件名自动带上 epro2 扩展名）
const documentFile = await eda.sys_FileManager.getDocumentFile('嘉立创示例_文档导出');

// 2. 输出文件信息（size 单位为字节）
console.log('文件名：', documentFile.name);
console.log('文件大小：', documentFile.size);