Get Started
Usage API
More information

SetScaleFlag

SetScaleFlag(sScaleFlag) → { boolean }

Sets the scaling condition to the current picture form.

Parameters:

Name Type Description
sScaleFlag ScaleFlag

Picture scaling condition: "always", "never", "tooBig" or "tooSmall".

Returns:

Type
boolean

Example

Copy code
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oPictureForm = Api.CreatePictureForm({"key": "Personal information", "tip": "Upload your photo", "required": true, "placeholder": "Photo", "lockAspectRatio": true, "respectBorders": false, "shiftX": 50, "shiftY": 50});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oPictureForm);
oPictureForm.SetImage("https://api.onlyoffice.com/content/img/editor/e-download.png");
oPictureForm.SetScaleFlag("tooBig");
var sScaleFlag = oPictureForm.GetScaleFlag();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Picture scale flag: " + sScaleFlag);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "SetScaleFlag.docx");
builder.CloseFile();

Resulting document