SetFormKey

Sets a key to the current form.

Inherited from ApiFormBase.SetFormKey.

Syntax

expression.SetFormKey(sKey);

expression - A variable that represents an ApiCheckBoxForm class.

Parameters

Name	Required/Optional	Data type	Default	Description
sKey	Required	string		Form key.

Returns

boolean

Example

Assign a unique key to each checkbox form to identify it later in a document.

// 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);