TRY NEW VERSION

SetProperty

HRESULT SetProperty([in] BSTR key, [in] BSTR value);

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:

Name Type Description
key BSTR The parameter name, the value is always --argument.
value BSTR The parameter value which will be used in the document.

Supported properties:

Name Type Description Default
--use-doctrenderer-scheme VARIANT_BOOL Specifies if the doctrenderer mode is used when building a document or getting content from the editor when saving a file. false
--check-fonts VARIANT_BOOL Specifies if the system fonts are cached for faster work. true
--work-directory BSTR The path to the temporary directory. ""
--cache-scripts VARIANT_BOOL Specifies if the sdkjs scripts are cached. true
--save-use-only-names VARIANT_BOOL Specifies if the destination paths are used (for server work). For example: /home/user/1.txt => /tmp/1.txt false
--all-fonts-path BSTR The path to the AllFonts.js script. ""
--argument BSTR The JSON argument which is sent to the global parameters of all the opened JS context. ""
--fonts-system VARIANT_BOOL Specifies if the system fonts are used. true
--fonts-dir BSTR 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

COM

CoInitialize(NULL);
IONLYOFFICEDocBuilder* oBuilder = NULL;
oBuilder->Initialize();
oBuilder->SetProperty("--argument", L"{\"name\":\"ONLYOFFICE\"}");
oBuilder->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

COM

CoInitialize(NULL);
IONLYOFFICEDocBuilder* oBuilder = NULL;
oBuilder->Initialize();
oBuilder->SetProperty("--check-fonts", L"true");
oBuilder->Dispose();

.docbuilder

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