跳到主要内容

SetFormKey

为当前表单设置键。

继承自 ApiFormBase.SetFormKey。

语法​

expression.SetFormKey(sKey);

expression - 表示 ApiComboBoxForm 类的变量。

参数​

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

返回值​

boolean

示例​

在文档中为组合框表单字段分配唯一标识键。

// How do I label a combo box form with a key so it can be referenced later in a document?

// Tag a form field with a custom key and then read it back to confirm the assignment in a document.

let doc = Api.GetDocument();
let comboBoxForm = Api.CreateComboBoxForm({"tip": "Choose your country", "required": true, "placeholder": "Country", "editable": false, "autoFit": false, "items": ["Latvia", "USA", "UK"]});
let paragraph = doc.GetElement(0);
paragraph.AddElement(comboBoxForm);
comboBoxForm.SetFormKey("Personal information");
let key = comboBoxForm.GetFormKey();
paragraph = Api.CreateParagraph();
paragraph.AddText("Form key: " + key);
doc.Push(paragraph);