TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

IsRequired

IsRequired() → { boolean }

Inherited From: ApiFormBase#IsRequired

Checks if the current form is required.

Parameters:

This method doesn't have any parameters.

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);
var bRequired = oDateForm.IsRequired();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("The first form from this document is required: " + bRequired);
oDocument.Push(oParagraph);
builder.SaveFile("pdf", "IsRequired.pdf");
builder.CloseFile();

Resulting document