SetRequired

SetRequired(bRequired) → { boolean }

Inherited From: ApiFormBase#SetRequired

Specifies if the current form should be required.

Parameters:

Name Type Description
bRequired boolean

Defines if the current form is required (true) or not (false).

Returns:

Type
boolean

Example

Copy code
builder.CreateFile("pdf");
var oDocument = Api.GetDocument();
var oDateForm = Api.CreateDateForm({"key": "Nowadays", "tip": "Enter current date", "required": true, "placeholder": "Date", "format": "mm.dd.yyyy", "lang": "en-US"});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oDateForm);
oDateForm.SetRequired(true);
var bRequired = oDateForm.IsRequired();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("The first form from this document is required: " + bRequired);
oDocument.Push(oParagraph);
builder.SaveFile("pdf", "SetRequired.pdf");
builder.CloseFile();

Resulting document