Interface IStringPropertyItemOptions

Optional properties for String property item

interface IStringPropertyItemOptions {
    enable?: boolean;
    hiddenLabel?: boolean;
    onChange?: (newValue: string, oldValue: string) => void;
    regexPattern?: string;
    title?: LocalizedString;
    tooltip?: LocalizedString;
    visible?: boolean;
}

Hierarchy (View Summary)

Properties

enable? hiddenLabel? onChange? regexPattern? title? tooltip? visible?

Properties

Optionalenable

enable?: boolean

Remarks

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

OptionalhiddenLabel

hiddenLabel?: boolean

Remarks

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

OptionalonChange

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

Remarks

This callback is called when UI control value is changed.

OptionalregexPattern

regexPattern?: string

Remarks

Optional regular expression pattern to validate string.

Optionaltitle

title?: LocalizedString

Remarks

Localized title of the property item.

Optionaltooltip

tooltip?: LocalizedString

Remarks

Tooltip description of the property item.

Optionalvisible

visible?: boolean

Remarks

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

Settings

Member Visibility

On This Page

Properties