Skip to main content

GetLock

Returns the lock state of the current form.

Inherited from ApiFormBase.GetLock.

Example​

Check the lock status of a form field in a document.

// How do I find out whether a form field is locked in a document?

// Protect a form, then confirm the lock is active by reading the lock state.

let doc = Api.GetDocument();
let textForm = Api.CreateTextForm({"key": "Personal information", "tip": "Enter your first name", "required": true, "placeholder": "First name", "comb": true, "maxCharacters": 10, "cellWidth": 3, "multiLine": false, "autoFit": false});
let paragraph = doc.GetElement(0);
paragraph.AddElement(textForm);
textForm.SetLock(true);
let locked = textForm.GetLock();
paragraph = Api.CreateParagraph();
paragraph.AddText("The first form from this document is locked: " + locked);
doc.Push(paragraph);