Script API - v1.26.10.20
    Preparing search index...

    Interface IStringPropertyItemOptions

    Optional properties for String property item

    interface IStringPropertyItemOptions {
        enable?: boolean;
        hasClearButton?: boolean;
        hiddenLabel?: boolean;
        inlineLabel?: boolean;
        multilineHeight?: number;
        onChange?: (newValue: string, oldValue: string) => void;
        regexPattern?: string;
        style?: PaneItemStyle;
        title?: LocalizedString;
        tooltip?: BasicTooltipContent;
        visible?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    enable? hasClearButton? hiddenLabel? inlineLabel? multilineHeight? onChange? regexPattern? style? title? tooltip? visible?

    Properties

    enable?: boolean

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

    hasClearButton?: boolean

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

    hiddenLabel?: boolean

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

    inlineLabel?: boolean

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

    multilineHeight?: number

    If defined, string will be handled as multiline input.

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

    This callback is called when UI control value is changed.

    regexPattern?: string

    Optional regular expression pattern to validate string.

    style?: PaneItemStyle

    Optional styling overrides for the item.

    title?: LocalizedString

    Localized title of the property item.

    tooltip?: BasicTooltipContent

    Tooltip description of the property item.

    visible?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties