SetLock

Sets the lock to the current block text content control:

• "unlocked" - content can be edited and the container can be deleted.
• "contentLocked" - content cannot be edited.
• "sdtContentLocked" - content cannot be edited and the container cannot be deleted.
• "sdtLocked" - the container cannot be deleted.

Syntax

expression.SetLock(lockType);

expression - A variable that represents a ApiBlockLvlSdt class.

Parameters

Name	Required/Optional	Data type	Default	Description
lockType	Required	"unlocked" | "contentLocked" | "sdtContentLocked" | "sdtLocked"		The type of the lock applied to the block text content control.

Returns

boolean

Example

Prevent editing of a content control's text in a document.

// How do I lock a content control so its content cannot be changed in a document?

// Protect a content control from modification and display the applied lock type in a document.

let doc = Api.GetDocument();
let blockLvlSdt = Api.CreateBlockLvlSdt();
blockLvlSdt.GetContent().GetElement(0).AddText("This is a block text content control with the content lock set to it.");
blockLvlSdt.SetLock("sdtContentLocked");
doc.AddElement(0, blockLvlSdt);
let lock = blockLvlSdt.GetLock();
let paragraph = doc.GetElement(1);
paragraph.AddText("Lock type: " + lock);