evCreate API 5.7 Help

SetLocked Function

Locks or unlocks a given object item from an Envision document currently opened in the Canvas Envision Creator app against editing.

SetLocked(obj: [[[EvItem|canvas-envision-document-items.html#object-items]]], isLocked: boolean): Promise<void>

Parameters

obj: EvItem

An Object item object, an object item from the Envision document currently opened in the Canvas Envision Creator app that should be locked or unlocked against editing.

isLocked: boolean

A Boolean, a switch to lock (true) or unlock (false) the given object item against editing.

Return value

Promise<void>

A Promise that, if fulfilled, resolves to void if the given object item in the current Envision document has been successfully locked or unlocked against editing.

27 March 2025