Skip to main content

Clear

Clears the current form.

Inherited from ApiFormBase.Clear.

Syntax​

expression.Clear();

expression - A variable that represents an ApiTextForm class.

Parameters​

This method doesn't have any parameters.

Returns​

boolean

Example​

Remove the entered value from a text input field in a document.

// How do I wipe the content of a text field without removing the field itself in a document?

// Reset a text entry area to its empty state 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);
textForm.SetText("John Smith");
textForm.Clear();
paragraph = Api.CreateParagraph();
paragraph.AddText("The first form from this document was cleared.");
doc.Push(paragraph);