SaveFile

Saves the file after all the changes are made. The type of the file which will be saved needs to be set.

Syntax

Python

def SaveFile(self, type: int | str, path: str, params: str | None = None) -> bool

C++

int SaveFile(int nExtension, const wchar_t* sPath, const wchar_t* sParams);

COM

HRESULT SaveFile([in] BSTR type, [in] BSTR path, [out, retval] VARIANT_BOOL* result);

Java

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

.Net

bool SaveFile(int nType, String^ sPath, String^ sParams);

JS

SaveFile(type, path, params)

Parameters

Python

Name	Type	Default	Description
type	int | str		The file type as a hexadecimal integer (OFFICESTUDIO_FILE_XXX values) or a string (docx, odt, rtf, txt, pptx, xlsx, ods, csv, pdf).
path	str		The path to the file to be saved together with its name and extension.
params	str | None	None	The parameters needed for the correct file saving (most commonly, the encoding is used for the txt and csv file types or the delimiter for the csv files, for other file types this is just an empty string). The parameters are added in the form of XML tags, where m_nCsvTxtEncoding is used for the text encoding and m_nCsvDelimiter is used for the csv delimiter. You can find all the supported values for the encoding in this file. The supported values for the csv delimiters include: 0 - no delimiter; 1 - tab; 2 - semicolon; 3 - colon; 4 - comma; 5 - space. When saving into an image file (png or jpg) for creating thumbnails, the additional parameters are used. See below to find them out.

C++

Name	Type	Description
nExtension	int	The file type as a hexadecimal integer (see OFFICESTUDIO_FILE_XXX values).
sPath	const wchar_t*	The path to the file to be saved together with its name and extension.
sParams	const wchar_t*	The parameters needed for the correct file saving (most commonly, the encoding is used for the txt and csv file types or the delimiter for the csv files, for other file types this is just an empty string). The parameters are added in the form of XML tags, where m_nCsvTxtEncoding is used for the text encoding and m_nCsvDelimiter is used for the csv delimiter. You can find all the supported values for the encoding in this file. The supported values for the csv delimiters include: 0 - no delimiter; 1 - tab; 2 - semicolon; 3 - colon; 4 - comma; 5 - space. When saving into an image file (png or jpg) for creating thumbnails, the additional parameters are used. See below to find them out.

COM

Name	Type	Description
type	BSTR	The file extension (see Supported formats).
path	BSTR	The path to the file to be saved together with its name and extension.
result	VARIANT_BOOL*	Specifies if the operation of saving a file is successful or not.

Java

Name	Type	Description
type	int | String	The file type as a hexadecimal integer (OFFICESTUDIO_FILE_XXX values) or a string (docx, odt, rtf, txt, pptx, xlsx, ods, csv, pdf).
path	String	The path to the file to be saved together with its name and extension.
params	String	The parameters needed for the correct file saving (most commonly, the encoding is used for the txt and csv file types or the delimiter for the csv files, for other file types this is just an empty string). The parameters are added in the form of XML tags, where m_nCsvTxtEncoding is used for the text encoding and m_nCsvDelimiter is used for the csv delimiter. You can find all the supported values for the encoding in this file. The supported values for the csv delimiters include: 0 - no delimiter; 1 - tab; 2 - semicolon; 3 - colon; 4 - comma; 5 - space. When saving into an image file (png or jpg) for creating thumbnails, the additional parameters are used. See below to find them out.

.Net

Name	Type	Description
nType	int	The file type as a hexadecimal integer (OFFICESTUDIO_FILE_XXX values).
sPath	String^	The path to the file to be saved together with its name and extension.
sParams	String^	The parameters needed for the correct file saving (most commonly, the encoding is used for the txt and csv file types or the delimiter for the csv files, for other file types this is just an empty string). The parameters are added in the form of XML tags, where m_nCsvTxtEncoding is used for the text encoding and m_nCsvDelimiter is used for the csv delimiter. You can find all the supported values for the encoding in this file. The supported values for the csv delimiters include: 0 - no delimiter; 1 - tab; 2 - semicolon; 3 - colon; 4 - comma; 5 - space. When saving into an image file (png or jpg) for creating thumbnails, the additional parameters are used. See below to find them out.

JS

Name	Type	Description
type	String	The file extension: docx, odt, rtf, txt, pptx, xlsx, ods, csv, pdf (see Supported formats).
path	String	The path to the file to be saved together with its name and extension.
params	String	Optional. The parameters for file saving (encoding for txt/csv, delimiter for csv). See Saving into images for thumbnail parameters.

Example

Python

builder = docbuilder.CDocBuilder()
dstPath = os.getcwd() + "/result.docx"
builder.SaveFile("docx", dstPath)

C++

std::wstring sWorkDirectory = NSUtils::GetBuilderDirectory();
CDocBuilder::Initialize(sWorkDirectory.c_str());
CDocBuilder oBuilder;
std::wstring sDstPath = sProcessDirectory + L"/result.docx";
oBuilder.SaveFile("docx", sDstPath.c_str());
CDocBuilder::Dispose();

COM

CoInitialize(NULL);
IONLYOFFICEDocBuilder* oBuilder = NULL;
VARIANT_BOOL b;
oBuilder->Initialize();
oBuilder->SaveFile("docx", "result.docx", &b);
oBuilder->Dispose();

Java

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

.Net

string workDirectory = "C:/Program Files/ONLYOFFICE/documentBuilder";
string resultPath = "result.docx";
var doctype = (int)OfficeFileTypes.Document.DOCX;
CDocBuilder.Initialize(workDirectory);
CDocBuilder oBuilder = new CDocBuilder();
oBuilder.SaveFile(doctype, resultPath);
CDocBuilder.Destroy();

JS

builder.CreateFile("docx");
builder.SaveFile("docx", "result.docx");
builder.CloseFile();

Saving into images

ONLYOFFICE Document Builder allows to save your document files into image files creating thumbnails of the first page or of all the pages in the document. This is done using the parameters of the SaveFile method. The parameters are added in the form of XML tags, where the following tags can be used:

• m_oThumbnail - the core tag showing that the inner nodes will be used to create a thumbnail out of the document file;
• format - the image file format used to create a thumbnail (can be of the following values: 3 - for a JPG file, 4 - for a PNG file);
• aspect - the image aspect when creating a thumbnail from the document file (can be of the following values: 1 - will keep the original aspect, 0 - will stretch the image to fit the width and the height set below);
• first - whether only the first page or all the pages should be converted into a thumbnail (can be of the following values: true - only the first page will be converted, false - all the document pages will be used to create thumbnails, in this case the file will be saved as an archive of images, one for each page);
• width - the image width in pixels;
• height - the image height in pixels.

Example

Python

builder.SaveFile(docbuilder.FileTypes.Graphics.PNG, "images.zip", "<m_oThumbnail><format>4</format><aspect>1</aspect><first>false</first><width>1000</width><height>1000</height></m_oThumbnail>")

C++

oBuilder.SaveFile(OFFICESTUDIO_FILE_IMAGE, L"thumbnail.png", "<m_oThumbnail><format>4</format><aspect>1</aspect><first>false</first><width>1000</width><height>1000</height></m_oThumbnail>");

COM

oBuilder->SaveFile("image", "thumbnail.png", "<m_oThumbnail><format>4</format><aspect>1</aspect><first>false</first><width>1000</width><height>1000</height></m_oThumbnail>", &b);

Java

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

.Net

oBuilder.SaveFile(OFFICESTUDIO_FILE_IMAGE, "thumbnail.png", "<m_oThumbnail><format>4</format><aspect>1</aspect><first>false</first><width>1000</width><height>1000</height></m_oThumbnail>");

JS

builder.CreateFile("docx");
builder.SaveFile("image", "./thumbnail.png", "<m_oThumbnail><format>4</format><aspect>1</aspect><first>false</first><width>1000</width><height>1000</height></m_oThumbnail>");
builder.CloseFile();