Set

Sets an array value by its index.

note

This method is not available for JS.

Syntax

Python

def Set(self, key: int, value: CDocBuilderValue) -> None

C++

void Set(const int& nIndex, CDocBuilderValue sValue);

COM

HRESULT Set([in] long index, [in] I_DOCBUILDER_VALUE** value);

Java

void set(int index, Object value);
void set(String index, Object value);

.Net

void Set(int nIndex, CDocBuilderValue^ sValue);

Parameters

Python

Name	Type	Description
key	int	The index of the array value.
value	CDocBuilderValue	The array value to be set.

C++

Name	Type	Description
nIndex	const int&	The index of the array value.
sValue	CDocBuilderValue	The value to be set.

COM

Name	Type	Description
index	long	The index of the array value.
value	I_DOCBUILDER_VALUE**	The array value to be set.

Java

Name	Type	Description
index	int | String	The index or name of the array value.
value	Object	The array value to be set.

.Net

Name	Type	Description
nIndex	int	The index of the array value.
sValue	CDocBuilderValue^	The array value to be set.

Example

Python

builder = docbuilder.CDocBuilder()
context = builder.GetContext()
globalObj = context.GetGlobal()
api = globalObj["Api"]
document = api.GetDocument()
charts = document.GetAllCharts()
chart = api.CreateChart("bar3D", [[200, 240, 280], [250, 260, 280]],
                        ["Projected Revenue", "Estimated Costs"], [2014, 2015, 2016],
                        4051300, 2347595, 24)
charts.Set(1, chart)

C++

std::wstring sWorkDirectory = NSUtils::GetBuilderDirectory();
CDocBuilder::Initialize(sWorkDirectory.c_str());
CDocBuilder oBuilder;
CContext oContext = oBuilder.GetContext();
CValue oGlobal = oContext.GetGlobal();
CValue oApi = oGlobal["Api"];
CValue oDocument = oApi.Call("GetDocument");
CValue aCharts = oDocument.Call("GetAllCharts");
CValue oChart = oApi.Call("CreateChart", "bar3D", ...);
aCharts.Set(1, oChart);
CDocBuilder::Dispose();

COM

CoInitialize(NULL);
IONLYOFFICEDocBuilder* oBuilder = NULL;
CoCreateInstance(__uuidof(CONLYOFFICEDocBuilder), NULL, CLSCTX_INPROC_SERVER, __uuidof(IONLYOFFICEDocBuilder), (void**)&oBuilder);
IONLYOFFICEDocBuilderContext* oContext = NULL;
IONLYOFFICEDocBuilderValue* oGlobal = NULL;
IONLYOFFICEDocBuilderValue* oApi = NULL;
IONLYOFFICEDocBuilderValue* oDocument = NULL;
IONLYOFFICEDocBuilderValue* aParagraphs = NULL;
IONLYOFFICEDocBuilderValue* oParagraph = 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);
oDocument->Call(_bstr_t("GetAllParagraphs"), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), &aParagraphs);
oApi->Call(_bstr_t("CreateParagraph"), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), ATL::CComVariant(), &oParagraph);
aParagraphs->Set(1, oParagraph);
oBuilder->Dispose();

Java

CDocBuilder.initialize("");
CDocBuilder builder = new CDocBuilder();
CDocBuilderContext context = builder.getContext();
CDocBuilderValue global = context.getGlobal();
CDocBuilderValue api = global.get("Api");
CDocBuilderValue doc = api.call("GetDocument");
CDocBuilderValue charts = doc.call("GetAllCharts");
CDocBuilderValue chart = api.call("CreateChart", "bar3D", ...);
charts.set(1, chart);
CDocBuilder.dispose();

.Net

string workDirectory = "C:/Program Files/ONLYOFFICE/documentBuilder";
CDocBuilder.Initialize(workDirectory);
CDocBuilder oBuilder = new CDocBuilder();
CContext oContext = oBuilder.GetContext();
CValue oGlobal = oContext.GetGlobal();
CValue oApi = oGlobal["Api"];
CValue oDocument = oApi.Call("GetDocument");
CValue aCharts = oDocument.Call("GetAllCharts");
CValue oChart = oApi.Call("CreateChart", "bar3D", ...);
aCharts.Set(1, oChart);
CDocBuilder.Destroy();

Index operator

The operator[] postfix expression can also be used to set an array value by its index:

Python

array[index] = value

C++

array[index] = value;

COM

This operator is not available. Use the Set method instead.

Java

array[index] = value

.Net

property CDocBuilderValue^ default[int]