Skip to main content

CreateComboBoxForm

Creates a combo box / dropdown list with the specified combo box / dropdown list properties.

Syntax

expression.CreateComboBoxForm(formPr);

expression - A variable that represents a Api class.

Parameters

NameRequired/OptionalData typeDefaultDescription
formPrRequiredComboBoxFormPrCombo box / dropdown list properties.

Returns

ApiComboBoxForm

Example

Create a dropdown list where users select from preset options in a document.

// How do I add a dropdown field to a document?

// Set up a selection menu with multiple choices that users can pick from in a document.

let doc = Api.GetDocument();
let comboBoxForm = Api.CreateComboBoxForm({
"key": "Personal information",
"tip": "Choose your country",
"required": true,
"placeholder": "Country",
"editable": false,
"autoFit": false,
"items": ["Latvia", "USA", "UK"]
});
let paragraph = doc.GetElement(0);
paragraph.AddElement(comboBoxForm);