SetRequired

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

继承自 ApiFormBase.SetRequired。

语法

expression.SetRequired(bRequired);

expression - 表示 ApiComboBoxForm 类的变量。

参数

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

返回值

boolean

示例

在文档中将组合框表单标记为必填。

// How do I make a combo box form required in a document?

// Enforce that a user must fill in a combo box before submitting a form in a document.

let doc = Api.GetDocument();
let comboBoxForm = Api.CreateComboBoxForm({"key": "Personal information", "tip": "Choose your country", "placeholder": "Country", "editable": false, "autoFit": false, "items": ["Latvia", "USA", "UK"]});
let paragraph = doc.GetElement(0);
paragraph.AddElement(comboBoxForm);
comboBoxForm.SetRequired(true);
let required = comboBoxForm.IsRequired();
paragraph = Api.CreateParagraph();
paragraph.AddText("The first form from this document is required: " + required);
doc.Push(paragraph);