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)

IPropertyItemBase
- IButtonPropertyItem

Index

Properties

enable id paneId typeName visible

Methods

replaceAction setIcon setTitle setTooltip

Properties

enable

enable: boolean

Remarks

If the item is enabled in the UI.

`Readonly`id

id: string

Remarks

Unique ID for the property item.

`Readonly`paneId

paneId: string

Remarks

The parent pane id.

`Readonly`typeName

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

replaceAction(action: RegisteredAction<NoArgsAction>): void
Parameters
- action: RegisteredAction<NoArgsAction>
  New action to replace the existing with.
Returns void
Remarks
Replace action assigned to the button.

setIcon

setIcon(icon: string): void
Parameters
- icon: string
  New button icon.
Returns void
Remarks
Updates icon of the button.

setTitle

setTitle(title: LocalizedString): void
Parameters
- title: LocalizedString
  New button title.
Returns void
Remarks
Updates title of the button.

setTooltip

setTooltip(tooltip: LocalizedString): void
Parameters
- tooltip: LocalizedString
  New button tooltip.
Returns void
Remarks
Updates tooltip description of the button.