CreateArray

Creates an array value, an analogue of new Array (length) in JS.

note

For the .docbuilder file the CDocBuilderContext.CreateArray method is not used.

Syntax

Python

def CreateArray(self, length: int) -> CDocBuilderValue

C++

CDocBuilderValue CreateArray(const int& nLength);

COM

HRESULT CreateArray([in] long length, [out, retval] I_DOCBUILDER_VALUE** result);

Java

CDocBuilderValue createArray(int length);

.Net

CDocBuilderValue^ CreateArray(int nLength);

Parameters

Python

Name	Type	Description
length	int	The array length.

C++

Name	Type	Description
nLength	const int&	The array length.

COM

Name	Type	Description
length	long	The array length.
result	I_DOCBUILDER_VALUE**	The returned array.

Java

Name	Type	Description
length	int	The array length.

.Net

Name	Type	Description
nLength	int	The array length.

Example

Python

import os
import docbuilder

builder = docbuilder.CDocBuilder()
builder.CreateFile("docx")

context = builder.GetContext()
globalObj = context.GetGlobal()
api = globalObj["Api"]

document = api.GetDocument()
paragraph = api.CreateParagraph()
paragraph.AddText("Hello, World!")
content = context.CreateArray(1)
content[0] = paragraph
document.InsertContent(content)

dstPath = os.getcwd() + "/result.docx"
builder.SaveFile("docx", dstPath)
builder.CloseFile()

C++

std::wstring sWorkDirectory = NSUtils::GetBuilderDirectory();
CDocBuilder::Initialize(sWorkDirectory.c_str());
CDocBuilder oBuilder;
CContext oContext = oBuilder.GetContext();
CValue oArray = oContext.CreateArray(2);
CDocBuilder::Dispose();

COM

CoInitialize(NULL);
IONLYOFFICEDocBuilder* oBuilder = NULL;
IONLYOFFICEDocBuilderContext* oContext = NULL;
IONLYOFFICEDocBuilderValue* oContent = NULL;
oBuilder->Initialize();
oBuilder->GetContext(&oContext);
oContext->CreateArray(1, &oContent);
oBuilder->Dispose();

Java

CDocBuilder.initialize("");
CDocBuilder builder = new CDocBuilder();
CDocBuilderContext context = builder.getContext();
CDocBuilderValue arrayValue = context.createArray(2);
CDocBuilder.dispose();

.Net

string workDirectory = "C:/Program Files/ONLYOFFICE/documentBuilder";
CDocBuilder.Initialize(workDirectory);
CDocBuilder oBuilder = new CDocBuilder();
CContext oContext = oBuilder.GetContext();
CValue oArray = oContext.CreateArray(2);
CDocBuilder.Destroy();