TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

SetTipText

SetTipText(sText) → { boolean }

Inherited From: ApiFormBase#SetTipText

Sets the tip text to the current form.

Parameters:

Name Type Description
sText string

Tip text.

Returns:

Type
boolean

Example

Copy code
builder.CreateFile("docx");
var oDocument = Api.GetDocument();
var oTextForm = Api.CreateTextForm({"key": "Personal information", "required": true, "placeholder": "First name", "comb": true, "maxCharacters": 10, "cellWidth": 3, "multiLine": false, "autoFit": false});
var oParagraph = oDocument.GetElement(0);
oParagraph.AddElement(oTextForm);
oTextForm.SetTipText("Enter your first name");
var sTipText = oTextForm.GetTipText();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("Tip text: " + sTipText);
oDocument.Push(oParagraph);
builder.SaveFile("docx", "SetTipText.docx");
builder.CloseFile();

Resulting document