跳到主要内容

SetFormKey

为当前表单设置键。

继承自 ApiFormBase.SetFormKey。

语法​

expression.SetFormKey(sKey);

expression - 表示 ApiSignatureForm 类的变量。

参数​

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

返回值​

boolean

示例​

在文档中为签名字段分配唯一标识符。

// How do I label a signature field with a specific key so it can be referenced in a document?

// Tag a signature field with a custom name to link or group related fields in a document.

let doc = Api.GetDocument();
let signatureForm = Api.CreateSignatureForm({"tip": "Please sign here", "placeholder": "Signature"});
let paragraph = doc.GetElement(0);
paragraph.AddElement(signatureForm);
signatureForm.SetFormKey("Signature");
let key = signatureForm.GetFormKey();
paragraph = Api.CreateParagraph();
paragraph.AddText("Form key: " + key);
doc.Push(paragraph);