GetTag

Returns the tag attribute for the current form.

Inherited from ApiFormBase.GetTag.

Example

Read the tag attached to a form field in a document.

// How do I get the tag of a form field in a document?

// Label a form with a custom tag, then retrieve it to confirm it was stored correctly.

const doc = Api.GetDocument();
let paragraph = doc.GetElement(0);

const 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
});
textForm.SetTag('MY_TAG');
paragraph.AddElement(textForm);

const formTag = textForm.GetTag();
paragraph = Api.CreateParagraph();
paragraph.AddText("Form tag: " + formTag);
doc.Push(paragraph);