setProperty

void setProperty(param: String, value: String)

Description

Sets an argument to the builder class which can be trasferred to the program outside the CDocBuilder.executeCommand method, i.e. either as an additional property when running ONLYOFFICE Document Builder executable file or as a part of program code, but not included into the document file script.

Please note, that for the .docbuilder file the CDocBuilder.setProperty method is not used explicitly. The argument itself is used instead as an additional property for the executable. See the example below.

Parameters

paramString

The parameter name, the value is always --argument.

valueString

The parameter value which will be used in the document.

Supported properties

--use-doctrenderer-schemebooleandefault: false

Specifies if the doctrenderer mode is used when building a document or getting content from the editor when saving a file.

--check-fontsbooleandefault: true

Specifies if the system fonts are cached for faster work.

--work-directoryStringdefault: ""

The path to the temporary directory.

--cache-scriptsbooleandefault: true

Specifies if the sdkjs scripts are cached.

--save-use-only-namesbooleandefault: false

Specifies if the destination paths are used (for server work). For example: /home/user/1.txt => /tmp/1.txt.

--all-fonts-pathStringdefault: ""

The path to the AllFonts.js script.

--argumentStringdefault: ""

The JSON argument which is sent to the global parameters of all the opened JS context.

--fonts-systembooleandefault: true

Specifies if the system fonts are used.

--fonts-dirStringdefault: ""

The path to the additional fonts directory (may be many records).

Once added, the argument will be available as the Argument variable with its parameter values set:

Argument.name === "ONLYOFFICE" // true

Example

Java

CDocBuilder.initialize("");
CDocBuilder builder = new CDocBuilder();
builder.setProperty("--argument", L"{\"name\":\"ONLYOFFICE\"}");
CDocBuilder.dispose();

.docbuilder

docbuilder.exe "--argument={\"name\":\"ONLYOFFICE\"}" test.docbuilder

Adding or removing fonts

It is also possible to update the font list when you either add new fonts or remove old ones. To do this, the check-fonts variable is used.

Example

Java

CDocBuilder.initialize("");
CDocBuilder builder = new CDocBuilder();
builder.setProperty("--check-fonts", L"true");
CDocBuilder.dispose();

.docbuilder

docbuilder.exe "--check-fonts=true" test.docbuilder