#Interface: IStringPropertyItemOptions experimental

Beta

Optional properties for String property item

#Extends

• IPropertyItemOptionsBase

#Properties

#enable?

optional enable?: boolean

Beta

#Remarks

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

#Inherited from

IPropertyItemOptionsBase.enable

---

#filterProfanity?

optional filterProfanity?: boolean

Beta

#Remarks

If true, profanity filtering will be applied on blur and a warning modal will be shown. The field value will be cleared if profanity is detected.

---

#hasClearButton?

optional hasClearButton?: boolean

Beta

#Remarks

Shows clear button for the item. If undefined, it will be true.

---

#hiddenLabel?

optional hiddenLabel?: boolean

Beta

#Remarks

If true label text will be hidden. If undefined, the label will be visible by default.

---

#inlineLabel?

optional inlineLabel?: boolean

Beta

#Remarks

Displays label inline. If undefined, it will be true.

---

#multilineHeight?

optional multilineHeight?: number

Beta

#Remarks

If defined, string will be handled as multiline input.

---

#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.

---

#regexPattern?

optional regexPattern?: string

Beta

#Remarks

Optional regular expression pattern to validate string.

---

#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