跳到主要内容

SetFormKey

为当前表单设置键。

继承自 ApiFormBase.SetFormKey。

语法​

expression.SetFormKey(sKey);

expression - 表示 ApiPictureForm 类的变量。

参数​

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

返回值​

boolean

示例​

在文档中为图片表单分配标识符,以便按名称引用。

// How do I label a picture form with a unique key in a document?

// Tag a picture form with a meaningful name to make it easier to locate and manage in a document.

let doc = Api.GetDocument();
let pictureForm = Api.CreatePictureForm({"tip": "Upload your photo", "required": true, "placeholder": "Photo", "scaleFlag": "tooBig", "lockAspectRatio": true, "respectBorders": false, "shiftX": 50, "shiftY": 50});
pictureForm.SetImage("https://static.onlyoffice.com/assets/docs/samples/img/onlyoffice_logo.png", Api.MillimetersToEmus(70), Api.MillimetersToEmus(80));
let paragraph = doc.GetElement(0);
paragraph.AddElement(pictureForm);
pictureForm.SetFormKey("Personal information");
let key = pictureForm.GetFormKey();
paragraph = Api.CreateParagraph();
paragraph.AddText("Form key: " + key);
doc.Push(paragraph);