跳到主要内容

IsRequired

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

继承自 ApiFormBase.IsRequired。

语法​

expression.IsRequired();

expression - 表示 ApiSignatureForm 类的变量。

参数​

此方法没有任何参数。

返回值​

boolean

示例​

确认文档中的签名字段是否必须在提交文档之前完成。

// How do I check if a signature field is marked as mandatory in a document?

// Identify signature fields that cannot be skipped when filling out a form in a document.

let doc = Api.GetDocument();
let signatureForm = Api.CreateSignatureForm({"key": "Signature", "tip": "Please sign here", "placeholder": "Signature"});
let paragraph = doc.GetElement(0);
paragraph.AddElement(signatureForm);
let required = signatureForm.IsRequired();
paragraph = Api.CreateParagraph();
paragraph.AddText("The first form from this document is required: " + required);
doc.Push(paragraph);