Get Started
Usage API
More information

GetAllForms

GetAllForms() → { Array.<ApiTextForm> | Array.<ApiPictureForm> | Array.<ApiComboBoxForm> | Array.<ApiCheckBoxForm> }

Returns all existing forms in the document.

Parameters:

This method doesn't have any parameters.

Returns:

Type
Array.<ApiTextForm> | Array.<ApiPictureForm> | Array.<ApiComboBoxForm> | Array.<ApiCheckBoxForm>

Example

Copy code
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTextForm = 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});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oTextForm);
var oComboBoxForm = Api.CreateComboBoxForm({"key": "Personal information", "tip": "Choose your country", "required": true, "placeholder": "Country", "editable": false, "autoFit": false, "items": ["Latvia", "USA", "UK"]});
oParagraph.AddLineBreak();
oParagraph.AddElement(oComboBoxForm);
var aForms = oDocument.GetAllForms();
aForms[0].SetText("John Smith");
aForms[1].SelectListValue("USA");
builder.SaveFile("docx", "GetAllForms.docx");
builder.CloseFile();

Resulting document