跳到主要内容

SetProperty

为构建器类设置一个参数，该参数可以传递到 CDocBuilder.ExecuteCommand 方法之外的程序中，即可以作为运行 ONLYOFFICE Document Builder 可执行文件时的附加属性，也可以作为程序代码的一部分，但不包含在文档文件脚本中。

请注意，对于 .docbuilder 文件，不会显式使用 CDocBuilder.SetProperty 方法。而是将参数本身作为可执行文件的附加属性使用。请参见下面的示例。

语法​

void SetProperty(String^ sParam, String^ sValue);

参数​

参数名类型描述
sParamString^参数名称，其值始终为 --argument。
sValueString^将在文档中使用的参数值。

支持的属性​

名称数据类型默认值描述
--use-doctrenderer-schemeboolfalse指定在构建文档或保存文件时从编辑器获取内容时是否使用 doctrenderer 模式。
--check-fontsbooltrue指定是否缓存系统字体以提高工作速度。
--work-directoryString^""临时目录的路径。
--cache-scriptsbooltrue指定是否缓存 sdkjs 脚本。
--save-use-only-namesboolfalse指定是否使用目标路径（用于服务器工作）。例如：/home/user/1.txt => /tmp/1.txt。
--all-fonts-pathString^""AllFonts.js 脚本的路径。
--argumentString^""发送到所有已打开 JS 上下文的全局参数的 JSON 参数。
--fonts-systembooltrue指定是否使用系统字体。
--fonts-dirString^""附加字体目录的路径（可能有多个记录）。

添加后，该参数将作为 Argument 变量可用，其参数值已设置：

Argument.name === "ONLYOFFICE" // true

示例​

string workDirectory = "C:/Program Files/ONLYOFFICE/documentBuilder";
CDocBuilder.Initialize(workDirectory);
CDocBuilder oBuilder = new CDocBuilder();
oBuilder.SetProperty("--argument", L"{\"name\":\"ONLYOFFICE\"}");
CDocBuilder.Destroy();

添加或删除字体​

当添加新字体或删除旧字体时，也可以更新字体列表。为此，将使用 check-fonts 变量：

示例​

string workDirectory = "C:/Program Files/ONLYOFFICE/documentBuilder";
CDocBuilder.Initialize(workDirectory);
CDocBuilder oBuilder = new CDocBuilder();
oBuilder.SetProperty("--check-fonts", L"true");
CDocBuilder.Destroy();