Skip to main content

GetTipText

Returns the tip text of the current form.

Inherited from ApiFormBase.GetTipText.

Syntax​

expression.GetTipText();

expression - A variable that represents an ApiTextForm class.

Parameters​

This method doesn't have any parameters.

Returns​

string

Example​

Retrieve the tooltip hint text set on a form field in a document.

// How do I read the hint message shown to users when they hover over a field in a document?

// Display the guidance message attached to a text field 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 tipText = textForm.GetTipText();
paragraph = Api.CreateParagraph();
paragraph.AddText("Form tip text: " + tipText);
doc.Push(paragraph);