跳到主要内容

GetFormValueByKey

返回指定键的表单值。对于一组单选按钮,返回 Choice,即所选项目的名称。

语法

expression.GetFormValueByKey(key);

expression - 表示 ApiDocument 类的变量。

参数

名称必需/可选数据类型默认值描述
key必需string表单键。

返回值

null | boolean | string

示例

此示例展示如何使用键获取指定表单的值。

let doc = Api.GetDocument();
let paragraph1 = doc.GetElement(0);
let checkBox = Api.CreateCheckBoxForm({key: "BestCompany"});
checkBox.SetChecked(true);
paragraph1.Push(checkBox);
let textForm = Api.CreateTextForm({key: "CompanyName"});
textForm.SetText("OnlyOffice");
paragraph1.Push(textForm);

let paragraph = Api.CreateParagraph();
doc.Push(paragraph);
let formValue = doc.GetFormValueByKey("CompanyName");
paragraph.AddText("CompanyName: " + formValue);
paragraph.AddLineBreak();
formValue = doc.GetFormValueByKey("BestCompany");
paragraph.AddText("BestCompany: " + formValue);