Interface IButtonPropertyItem

A property item which supports Button properties

interface IButtonPropertyItem {
    enable: boolean;
    id: string;
    paneId: string;
    typeName: PropertyItemType;
    visible: boolean;
    replaceAction(action: RegisteredAction<NoArgsAction>): void;
    setIcon(icon: string): void;
    setTitle(title: LocalizedString): void;
    setTooltip(tooltip: LocalizedString): void;
}

Hierarchy (View Summary)

Properties

enable id paneId typeName visible

Methods

replaceAction setIcon setTitle setTooltip

Properties

enable

enable: boolean

Remarks

If the item is enabled in the UI.

Readonlyid

id: string

Remarks

Unique ID for the property item.

ReadonlypaneId

paneId: string

Remarks

The parent pane id.

ReadonlytypeName

typeName: PropertyItemType

Remarks

The type name of the target property.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

replaceAction

setIcon

  • setIcon(icon: string): void

  • Parameters

    • icon: string

      New button icon.

    Returns void

    Remarks

    Updates icon of the button.

setTitle

setTooltip

  • setTooltip(tooltip: LocalizedString): void

  • Parameters

    Returns void

    Remarks

    Updates tooltip description of the button.

Settings

Member Visibility

On This Page

Properties
Methods