Skip to main content

GetFormType

Returns a type of the current form.

Inherited from ApiFormBase.GetFormType.

Syntax​

expression.GetFormType();

expression - A variable that represents an ApiTextForm class.

Parameters​

This method doesn't have any parameters.

Returns​

FormType

Example​

Read the type of a fillable field in a document.

// How do I determine what kind of fillable field is present in a document?

// Distinguish a text field from other field varieties by checking its type in a document.

let doc = Api.GetDocument();
let textForm = Api.CreateTextForm({"key": "Personal information", "tip": "Enter your first name", "required": true, "placeholder": "First name", "comb": true, "maxCharacters": 10, "cellWidth": 3, "multiLine": false, "autoFit": false});
let paragraph = doc.GetElement(0);
paragraph.AddElement(textForm);
let formType = textForm.GetFormType();
paragraph = Api.CreateParagraph();
paragraph.AddText("Form type: " + formType);
doc.Push(paragraph);