ExecuteCommand
执行用于创建文档文件(文本文档、电子表格、演示文稿、表单文档、PDF)的命令。有关各种文档类型可用命令的更多信息,请参阅 文本文档 API、电子表格 API、演示文稿 API 或 表单 API 部分。
备注
对于 JS,请直接调用 API 方法。
语法
- Python
- C++
- COM
- Java
- .Net
def ExecuteCommand(self, command: str, retValue: CDocBuilderValue | None = None) -> bool
bool ExecuteCommand(const wchar_t* sCommand, CDocBuilderValue* oRetValue = 0);
HRESULT ExecuteCommand([in] BSTR command, [out, retval] VARIANT_BOOL* result);
boolean executeCommand(String command, CDocBuilderValue retValue);
bool ExecuteCommand(String^ sCommand, CDocBuilderValue^% oRetValue);
参数
- Python
- C++
- COM
- Java
- .Net
| 名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| command | str | JavaScript 代码形式的命令,用于创建文档文件(在 Python 中,当命令包含引号时必须使用转义字符)。 | |
| retValue | CDocBuilderValue | None | None | 命令返回值。 |
| 名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| sCommand | const wchar_t* | 用于创建文档文件的命令(在 C++ 中,当命令包含引号时必须使用转义字符)。 | |
| oRetValue | CDocBuilderValue* | 0 | 命令返回值。 |
| 名称 | 类型 | 描述 |
|---|---|---|
| command | BSTR | 用于创建文档文件的命令(在 COM 中,当命令包含引号时必须使用转义字符)。 |
| result | VARIANT_BOOL* | 指定执行命令操作是否成功。 |
| 名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| command | String | JavaScript 代码形式的命令,用于创建文档文件(在 Java 中,当命令包含引号时必须使用转义字符)。 | |
| retValue | CDocBuilderValue | null | 命令返回值。 |
| 名称 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| sCommand | String^ | JavaScript 代码形式的命令,用于创建文档文件(在 .Net 中,当命令包含引号时必须使用转义字符)。 | |
| oRetValue | CDocBuilderValue^% | null | 命令返回值。 |
示例
- Python
- C++
- COM
- Java
- .Net
import os
import docbuilder
builder = docbuilder.CDocBuilder()
builder.CreateFile("docx")
builder.ExecuteCommand("var oDocument = Api.GetDocument();var oParagraph = oDocument.GetElement(0);oParagraph.AddText('Hello from Python!');")
dstPath = os.getcwd() + "/result.docx"
builder.SaveFile("docx", dstPath)
builder.CloseFile()
std::wstring sWorkDirectory = NSUtils::GetBuilderDirectory();
CDocBuilder::Initialize(sWorkDirectory.c_str());
CDocBuilder oBuilder;
oBuilder.ExecuteCommand(L"oParagraph.AddText(\"Hello, world!\");");
CDocBuilder::Dispose();
CoInitialize(NULL);
IONLYOFFICEDocBuilder* oBuilder = NULL;
IONLYOFFICEDocBuilderValue* oRun = NULL;
VARIANT_BOOL b;
oBuilder->Initialize();
oBuilder->Execute(L"oParagraph.AddText(\"Hello, world!\");", &oRun);
oBuilder->ExecuteCommand(L"oParagraph.SetSpacingAfter(1000, false);", &b);
oBuilder->Dispose();
CDocBuilder.initialize("");
CDocBuilder builder = new CDocBuilder();
builder.executeCommand("oParagraph.AddText(\"Hello from Java!\");");
CDocBuilder.dispose();
string workDirectory = "C:/Program Files/ONLYOFFICE/documentBuilder";
CDocBuilder.Initialize(workDirectory);
CDocBuilder oBuilder = new CDocBuilder();
oBuilder.ExecuteCommand("oParagraph.AddText(\"Hello from .Net!\");");
CDocBuilder.Destroy();