Run

Runs the ONLYOFFICE Document Builder executable with a script file as an argument.

note

This method is not available for JS.

Syntax

Python

def Run(self, path: str) -> bool

C++

bool Run(const wchar_t* sPath);

COM

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

Java

boolean run(String path);

.Net

bool Run(String^ sPath);

Parameters

Python

Name	Type	Description
path	str	The path to the JS script file.

C++

Name	Type	Description
sPath	const wchar_t*	The path to the JS script file.

COM

Name	Type	Description
path	BSTR	The path to the JS script file.
result	VARIANT_BOOL*	Specifies if the operation is successful or not.

Java

Name	Type	Description
path	String	The path to the JS script file.

.Net

Name	Type	Description
sPath	String^	The path to the JS script file.

Example

Python

import docbuilder

builder = docbuilder.CDocBuilder()
builder.Run("path-to-script.js")

C++

std::wstring sWorkDirectory = NSUtils::GetBuilderDirectory();
CDocBuilder::Initialize(sWorkDirectory.c_str());
CDocBuilder oBuilder;
oBuilder.Run(L"path-to-script.js");
CDocBuilder::Dispose();

COM

CoInitialize(NULL);
IONLYOFFICEDocBuilder* oBuilder = NULL;
CoCreateInstance(__uuidof(CONLYOFFICEDocBuilder), NULL, CLSCTX_INPROC_SERVER, __uuidof(IONLYOFFICEDocBuilder), (void**)&oBuilder);
VARIANT_BOOL b;
oBuilder->Run(_bstr_t("path-to-script.js"), &b);
oBuilder->Dispose();

Java

CDocBuilder.initialize("");
CDocBuilder builder = new CDocBuilder();
builder.run("path-to-script.js");
CDocBuilder.dispose();

.Net

string workDirectory = "C:/Program Files/ONLYOFFICE/documentBuilder";
CDocBuilder.Initialize(workDirectory);
CDocBuilder oBuilder = new CDocBuilder();
oBuilder.Run("path-to-script.js");
CDocBuilder.Destroy();