跳到主要内容

SetFormKey

为当前表单设置键。

继承自 ApiFormBase.SetFormKey。

语法​

expression.SetFormKey(sKey);

expression - 表示 ApiCheckBoxForm 类的变量。

参数​

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

返回值​

boolean

示例​

在文档中为每个复选框表单分配唯一键,以便之后识别。

// How do I set a unique identifier on a checkbox form in a document?

// Label multiple checkbox forms with distinct keys and read back the key to verify the assignment in a document.

let doc = Api.GetDocument();
let checkBoxForm = Api.CreateCheckBoxForm({"tip": "Specify your marital status", "required": true, "placeholder": "Marital status", "radio": false});
checkBoxForm.SetFormKey("Marital status 1");
let paragraph = doc.GetElement(0);
paragraph.AddElement(checkBoxForm);
paragraph.AddText(" Married");
paragraph.AddLineBreak();
checkBoxForm = Api.CreateCheckBoxForm({"tip": "Specify your marital status", "required": true, "placeholder": "Marital status", "radio": false});
checkBoxForm.SetFormKey("Marital status 2");
paragraph.AddElement(checkBoxForm);
paragraph.AddText(" Single");
let formKey = checkBoxForm.GetFormKey();
paragraph = Api.CreateParagraph();
paragraph.AddText("Form key: " + formKey);
doc.Push(paragraph);