Call

HRESULT Call(name: [in] BSTR, val1: [in, optional] VARIANT, val2: [in, optional] VARIANT, val3: [in, optional] VARIANT, val4: [in, optional] VARIANT, val5: [in, optional] VARIANT, val6: [in, optional] VARIANT, result: [out, retval] I_DOCBUILDER_VALUE**)

Description

Calls the specified Document Builder method. See the Text document API, Spreadsheet API, Presentation API, or Form API sections for more information which methods are available for various document types.

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

Parameters

nameBSTR
The name of the Document Builder method.
val1-val6VARIANT
The parameters that the Document Builder method takes as arguments.
The returned method value.

Example

COM

CoInitialize(NULL);
IONLYOFFICEDocBuilder* oBuilder = NULL;
IONLYOFFICEDocBuilderContext* oContext = NULL;
IONLYOFFICEDocBuilderValue* oGlobal = NULL;
IONLYOFFICEDocBuilderValue* oApi = NULL;
IONLYOFFICEDocBuilderValue* oDocument = NULL;
oBuilder->Initialize();
oBuilder->GetContext(&oContext);
oContext->GetGlobal(&oGlobal);
oGlobal->GetProperty(_bstr_t("Api"), &oApi);
oApi->Call(_bstr_t("GetDocument"), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), &oDocument);
oBuilder->Dispose();

.docbuilder

const oDocument = Api.GetDocument()

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).