跳到主要内容

saveFile

在所有更改完成后保存文件。需要设置将要保存的文件类型。

语法

int saveFile(int | String type, String path, String params);

参数

参数类型描述
typeint | String要保存的文件类型,在Java代码中设置为十六进制整数。对于.docbuilder脚本文件,可能的值有:docxodtrtftxtpptxxlsxodscsvpdf(参见OFFICESTUDIO_FILE_XXX值)。
pathString要保存的文件的路径,包含其名称和扩展名。
paramsString正确保存文件所需的参数(最常见的是,txtcsv文件类型使用的编码,或csv文件的分隔符,对于其他文件类型,此参数只是一个空字符串)。参数以XML标签的形式添加,其中m_nCsvTxtEncoding用于文本编码,m_nCsvDelimiter用于csv分隔符。您可以在此文件中找到所有支持的编码值。支持的csv分隔符值包括:
0 - 无分隔符;
1 - 制表符;
2 - 分号;
3 - 冒号;
4 - 逗号;
5 - 空格。
当保存为图像文件(pngjpg)以创建缩略图时,会使用其他参数。请参见下文保存为图像了解详情。

示例

String resultPath = "result.docx";
CDocBuilder.initialize("");
CDocBuilder builder = new CDocBuilder();
builder.saveFile(FileTypes.Document.DOCX, resultPath);
CDocBuilder.dispose();

保存为图像

ONLYOFFICE Document Builder允许将文档文件保存为图像文件,创建第一页或所有页的缩略图。这通过saveFile()方法的参数来实现。参数以XML标签的形式添加,可使用以下标签:

  • m_oThumbnail - 核心标签,表示将使用内部节点从文档文件创建缩略图;
  • format - 用于创建缩略图的图像文件格式(可能的值:3 - JPG文件,4 - PNG文件);
  • aspect - 从文档文件创建缩略图时的图像比例(可能的值:1 - 保持原始比例,0 - 拉伸图像以适应下面设置的宽度和高度);
  • first - 仅将第一页还是所有页转换为缩略图(可能的值:true - 仅转换第一页,false - 使用所有文档页创建缩略图,在这种情况下,文件将保存为图像归档,每页一个图像);
  • width - 图像宽度(以像素为单位);
  • height - 图像高度(以像素为单位)。

示例

builder.saveFile(FileTypes.Document.DOCX, L"thumbnail.png", "<m_oThumbnail><format>4</format><aspect>1</aspect><first>false</first><width>1000</width><height>1000</height></m_oThumbnail>");