CDocBuilder

Base class used by ONLYOFFICE Document Builder for the document file (text document, spreadsheet, presentation, form document, PDF) to be generated.

Syntax

class CDocBuilder

Instance Methods

Name	Description
closeFile	Closes the file to stop working with it.
createFile	Creates a new file.
dispose	Unloads the ONLYOFFICE Document Builder from the application memory when it is no longer needed.
executeCommand	Executes the command which will be used to create the document file (text document, spreadsheet, presentation, form document, PDF).
getContext	Returns the current JS context.
getVersion	Returns the ONLYOFFICE Document Builder engine version.
initialize	Initializes the ONLYOFFICE Document Builder as a library for the application to be able to work with it.
isSaveWithDoctrendererMode	Specifies if the doctrenderer mode is used when building a document or getting content from the editor when saving a file.
openFile	Opens the document file which will be edited and saved afterwards.
run	Runs the ONLYOFFICE Document Builder executable.
runText	Runs all the commands for the document creation using a single command.
saveFile	Saves the file after all the changes are made.
setProperty	Sets an argument which can be transferred to the program outside the CDocBuilder.executeCommand method.
setTmpFolder	Sets the path to the folder where the program will temporarily save files needed for the program correct work.
writeData	Writes data to the log file.