SetProperty

为 CDocBuilderValue 对象设置属性。

请注意，对于 .docbuilder 文件，不使用 CDocBuilderValue.SetProperty 方法。

语法

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

参数

Python

名称	类型	描述
name	str	CDocBuilderValue 对象属性的名称。
value	CDocBuilderValue	CDocBuilderValue 对象属性的值。

C++

名称	类型	描述
sName	const wchar_t*	CDocBuilderValue 对象属性的名称。
sValue	CDocBuilderValue	CDocBuilderValue 对象属性的值。

COM

名称	类型	描述
name	BSTR	CDocBuilderValue 对象属性的名称。
value	I_DOCBUILDER_VALUE**	CDocBuilderValue 对象属性的值。

Java

名称	类型	描述
name	String	CDocBuilderValue 对象属性的名称。
value	Object	CDocBuilderValue 对象属性的值。

.Net

名称	类型	描述
sName	String^	CDocBuilderValue 对象属性的名称。
sValue	CDocBuilderValue^	CDocBuilderValue 对象属性的值。

示例

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();

设置属性的替代方法

还有两种方法可以为 CDocBuilderValue 对象设置属性：

1. 使用 Set 方法

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. 使用索引运算符

Python

document["property_name"] = value

C++

document["property_name"] = value;

Java

document["property_name"] = value;

.Net

document["property_name"] = value;