SetProperty

Sets a property to the CDocBuilderValue object.

Please note, that for the .docbuilder file the CDocBuilderValue.SetProperty method is not used.

Syntax

Python

def SetProperty(self, name: str, value: CDocBuilderValue) -> None

C++

void SetProperty(const wchar_t* sName, CDocBuilderValue sValue);

COM

HRESULT SetProperty([in] BSTR name, [in] I_DOCBUILDER_VALUE** value);

Java

void setProperty(String name, Object value);

.Net

void SetProperty(String^ sName, CDocBuilderValue^ sValue);

Parameters

Python

Name	Type	Description
name	str	The name of the CDocBuilderValue object property.
value	CDocBuilderValue	The value of the CDocBuilderValue object property.

C++

Name	Type	Description
sName	const wchar_t*	The name of the CDocBuilderValue object property.
sValue	CDocBuilderValue	The value of the CDocBuilderValue object property.

COM

Name	Type	Description
name	BSTR	The name of the CDocBuilderValue object property.
value	I_DOCBUILDER_VALUE**	The value of the CDocBuilderValue object property.

Java

Name	Type	Description
name	String	The name of the CDocBuilderValue object property.
value	Object	The value of the CDocBuilderValue object property.

.Net

Name	Type	Description
sName	String^	The name of the CDocBuilderValue object property.
sValue	CDocBuilderValue^	The value of the CDocBuilderValue object property.

Example

Python

builder = docbuilder.CDocBuilder()
context = builder.GetContext()
globalObj = context.GetGlobal()
api = globalObj["Api"]
document = api.Call("GetDocument")
document.SetProperty("color", colorValue)

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");
oDocument.SetProperty("color", colorValue);
CDocBuilder::Dispose();

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);
oDocument->SetProperty("color", colorValue);
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");
doc.setProperty("color", colorValue);
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");
oDocument.SetProperty("color", colorValue);
CDocBuilder.Destroy();

Alternative ways to set a property

There are two more ways to set a property to the CDocBuilderValue object:

1. Using the Set method

Python

def Set(self, name: str, value: CDocBuilderValue) -> None

C++

void Set(const wchar_t* name, CDocBuilderValue value);

Java

void set(String name, Object value);

.Net

void Set(String^ name, CDocBuilderValue^ value);

2. Using the index operator

Python

document["property_name"] = value

C++

document["property_name"] = value;

Java

document["property_name"] = value;

.Net

document["property_name"] = value;