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

    Interface IButtonPropertyItem

    A property item which supports Button properties

    export interface IButtonPropertyItem extends IPropertyItemBase {
    replaceAction(action: RegisteredAction<NoArgsAction>): void;
    setIcon(icon: string | undefined): void;
    setTitle(title: LocalizedString | undefined): void;
    setTooltip(tooltip: BasicTooltipContent | undefined): void;
    }
    interface IButtonPropertyItem {
        enable: boolean;
        id: string;
        paneId: string;
        typeName: PropertyItemType;
        visible: boolean;
        replaceAction(action: RegisteredAction<NoArgsAction>): void;
        setIcon(icon: string | undefined): void;
        setTitle(title: LocalizedString | undefined): void;
        setTooltip(tooltip: BasicTooltipContent | undefined): 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.

    visible: boolean

    If the item should be visible in the UI.

    Methods

    • Parameters

      • icon: string | undefined

        New button icon.

      Returns void

      Updates icon of the button.

    • Parameters

      Returns void

      Updates title of the button.

    • Parameters

      Returns void

      Updates tooltip description of the button.