Add
Adds a new value to the combo box / drop-down list content control.
Syntax
expression.Add(sText, sValue, nIndex);
expression - A variable that represents a ApiContentControlList class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| sText | Required | string | The display text for the list item. | |
| sValue | Required | string | The list item value. By default is equal to sText parameter | |
| nIndex | Optional | number | -1 | A position where a new value will be added. If nIndex=-1 add to the end. |
Returns
boolean
Example
This example shows how to add items to the content control list.
- Code
- Result
let doc = Api.GetDocument();
let cc = Api.CreateComboBoxContentControl([{display: "Mercury", value: "planet1"}, {display: "Earth", value: "planet3"}, {display: "Mars", value: "planet4"}], 2);
let contentControlList = cc.GetDropdownList();
contentControlList.Add("Venus", "planet2", 1);
let paragraph = doc.GetElement(0);
paragraph.Push(cc);