Skip to main content

AddListItem

Adds an item to a combo box list or drop-down list.

Syntax

expression.AddListItem(name, value, pos);

expression - A variable that represents a ApiInlineLvlSdt class.

Parameters

NameRequired/OptionalData typeDefaultDescription
nameRequiredstringThe name of the item to add to the list.
valueRequiredstringThe value of the item to add to the list.
posOptionalnumberThe optional position at which to insert the new item in the list.

Returns

boolean

Example

Add a list item to a combobox in a document.

// How to add the list item for an inline content control in a document?

// Add the list item and display the result in a document.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let contentControl = doc.AddComboBoxContentControl();
let paragraph1 = Api.CreateParagraph();
contentControl.AddListItem('one', '1');
contentControl.AddListItem('two', '2');
contentControl.SelectListItem('2');