SetRequired

指定当前表单是否为必填项。

继承自 ApiFormBase.SetRequired。

语法

expression.SetRequired(bRequired);

expression - 表示 ApiCheckBoxForm 类的变量。

参数

名称	必需/可选	数据类型	默认值	描述
bRequired	必需	boolean		定义当前表单是否为必填项（true）或非必填项（false）。

返回值

boolean

示例

在文档中将复选框表单标记为必填。

// How do I make a form field required so it cannot be skipped in a document?

// Enforce that respondents must interact with a checkbox before submitting a form in a document.

let doc = Api.GetDocument();
let checkBoxForm = Api.CreateCheckBoxForm({"key": "Marital status", "tip": "Specify your marital status", "placeholder": "Marital status", "radio": true});
let paragraph = doc.GetElement(0);
paragraph.AddElement(checkBoxForm);
paragraph.AddText(" Married");
paragraph.AddLineBreak();
checkBoxForm = Api.CreateCheckBoxForm({"key": "Marital status", "tip": "Specify your marital status", "placeholder": "Marital status", "radio": true});
paragraph.AddElement(checkBoxForm);
paragraph.AddText(" Single");
checkBoxForm.SetRequired(true);
let isRequired = checkBoxForm.IsRequired();
paragraph = Api.CreateParagraph();
paragraph.AddText("The second form from this document is required: " + isRequired);
doc.Push(paragraph);