SetPlaceholderText
Sets the placeholder text to the current form.
note
The placeholder text can't be set for checkbox or radio button forms.
Inherited from ApiFormBase.SetPlaceholderText.
Syntax
expression.SetPlaceholderText(sText);
expression - A variable that represents an ApiComboBoxForm class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| sText | Required | string | The text that will be set to the current form. |
Returns
boolean
Example
Set placeholder text on a combo box form in a document.
// How do I add placeholder text to a combo box form in a document?
// Guide users on what to select by displaying hint text inside an empty combo box in a document.
let doc = Api.GetDocument();
let comboBoxForm = Api.CreateComboBoxForm({"key": "Personal information", "tip": "Choose your country", "required": true, "editable": false, "autoFit": false, "items": ["Latvia", "USA", "UK"]});
let paragraph = doc.GetElement(0);
paragraph.AddElement(comboBoxForm);
comboBoxForm.SetPlaceholderText("Country");