GetLockValue

function GetLockValue(sType: DrawingLockType = null): bool

Description

Returns the lock value for the specified lock type of the current drawing.

Parameters

sTypeDrawingLockTypedefault: null

Lock type in the string format.

Returns

bool

Try It

var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oGs1 = Api.CreateGradientStop(Api.CreateRGBColor(255, 213, 191), 0);
var oGs2 = Api.CreateGradientStop(Api.CreateRGBColor(255, 111, 61), 100000);
var oFill = Api.CreateLinearGradientFill([oGs1, oGs2], 5400000);
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oDrawing = Api.CreateShape("rect", 5930900, 395605, oFill, oStroke);
oDrawing.SetLockValue("noSelect", true);
oParagraph.AddDrawing(oDrawing);
var oDocContent = oDrawing.GetContent();
var bLockValue = oDrawing.GetLockValue("noSelect");
oParagraph = Api.CreateParagraph();
oParagraph.AddText("This drawing cannot be selected: " + bLockValue);
oDocContent.AddElement(0, oParagraph);

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).