跳到主要内容

IsRequired

检查当前表单是否为必填项。

继承自 ApiFormBase.IsRequired。

语法​

expression.IsRequired();

expression - 表示 ApiPictureForm 类的变量。

参数​

此方法没有任何参数。

返回值​

boolean

示例​

确定文档中的图片表单是否为必填。

// How do I check if a picture form must be completed before the document is submitted in a document?

// Confirm that a picture form is marked as obligatory so it cannot be left empty in a document.

let doc = Api.GetDocument();
let pictureForm = Api.CreatePictureForm({"key": "Personal information", "tip": "Upload your photo", "required": true, "placeholder": "Photo", "scaleFlag": "tooBig", "lockAspectRatio": true, "respectBorders": false, "shiftX": 50, "shiftY": 50});
let paragraph = doc.GetElement(0);
paragraph.AddElement(pictureForm);
pictureForm.SetImage("https://static.onlyoffice.com/assets/docs/samples/img/onlyoffice_logo.png", Api.MillimetersToEmus(70), Api.MillimetersToEmus(80));
let required = pictureForm.IsRequired();
paragraph = Api.CreateParagraph();
paragraph.AddText("The first form from this document is required: " + required);
doc.Push(paragraph);