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

    Interface IComboBoxPropertyItem

    A property item which supports Combo Box properties

    export interface IComboBoxPropertyItem extends IPropertyItemBase {
    readonly value: string;
    setTitle(title: LocalizedString | undefined): void;
    setTooltip(tooltip: BasicTooltipContent | undefined): void;
    updateEntries(entries: IComboBoxPropertyItemEntry[] | undefined, newValue?: string): void;
    }
    interface IComboBoxPropertyItem {
        enable: boolean;
        id: string;
        paneId: string;
        typeName: PropertyItemType;
        value: string;
        visible: boolean;
        setTitle(title: LocalizedString | undefined): void;
        setTooltip(tooltip: BasicTooltipContent | undefined): void;
        updateEntries(
            entries: IComboBoxPropertyItemEntry[] | undefined,
            newValue?: string,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    enable: boolean

    If the item is enabled in the UI.

    id: string

    Unique ID for the property item.

    paneId: string

    The parent pane id.

    The type name of the target property.

    value: string

    Current value of the property item.

    visible: boolean

    If the item should be visible in the UI.

    Methods

    • Parameters

      Returns void

      Updates title of the property item.

    • Parameters

      • entries: IComboBoxPropertyItemEntry[] | undefined

        New list of updated entries.

      • OptionalnewValue: string

        New value to use for the combo box.

      Returns void

      Update list of combo box entries.