Execute

HRESULT Execute([in] BSTR command, [out, retval] I_DOCBUILDER_VALUE** result);

Executes the command which will be used to create the document file (text document, spreadsheet, presentation, form document, PDF). See the Text document API, Spreadsheet API, Presentation API, or Form API sections for more information which commands are available for various document types.

Please note, that for the .docbuilder file the CDocBuilder.Execute method is not used explicitly. The command itself is used instead. See the example below.

Parameters

NameTypeDescription
commandBSTRThe command which will be used to create the document file (the escape character must be used when the command contains quotation symbols).
resultI_DOCBUILDER_VALUE**The command return value.

Example

COM

CoInitialize(NULL);
IONLYOFFICEDocBuilder* oBuilder = NULL;
IONLYOFFICEDocBuilderValue* oRun = NULL;
oBuilder->Initialize();
oBuilder->Execute(L"oParagraph.AddText(\"Hello, world!\");", &oRun);
oBuilder->Dispose();

.docbuilder

oParagraph.AddText("Hello, world!")

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).