#Interface: IComboBoxPropertyItemOptions experimental

Beta

Optional properties for ComboBox property item

#Extends

• IPropertyItemOptionsBase

#Properties

#dataType?

optional dataType?: ComboBoxPropertyItemDataType

Beta

#Remarks

Possible data types supported by combo box. If undefined, it will be Custom by default.

---

#defaultValue?

optional defaultValue?: string

Beta

#Remarks

Default value to fall back to if entry is not found. If undefined, data type will determine the default value (empty string for Custom data type).

---

#enable?

optional enable?: boolean

Beta

#Remarks

Initial enabled state of property item. If undefined, it will default to true.

#Inherited from

IPropertyItemOptionsBase.enable

---

#entries?

optional entries?: IComboBoxPropertyItemEntry[]

Beta

#Remarks

List of combo box entries. If undefined, data type will determine the default list (empty list for Custom data type).

---

#hiddenLabel?

optional hiddenLabel?: boolean

Beta

#Remarks

If true label text will be hidden. It will be visible by default.

---

#onChange?

optional onChange?: (newValue, oldValue) => void

Beta

#Parameters

#newValue

string

#oldValue

string

#Returns

void

#Remarks

This callback is called when UI control value is changed.

---

#showImage?

optional showImage?: boolean

Beta

#Remarks

If true the image for the selected value will be displayed (if data type supports it). If undefined, it will default to false.

---

#style?

optional style?: PaneItemStyle

Beta

#Remarks

Optional styling overrides for the item.

#Inherited from

IPropertyItemOptionsBase.style

---

#title?

optional title?: LocalizedString

Beta

#Remarks

Localized title of the property item.

---

#tooltip?

optional tooltip?: BasicTooltipContent

Beta

#Remarks

Tooltip description of the property item.

---

#visible?

optional visible?: boolean

Beta

#Remarks

Initial visibility state of property item. If undefined, it will default to true.

#Inherited from

IPropertyItemOptionsBase.visible