Interface IButtonPropertyItem`Beta`

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: undefined | string): void;
    setTitle(title: undefined | LocalizedString): void;
    setTooltip(tooltip: undefined | LocalizedString): void;
}

Hierarchy (View Summary)

IPropertyItemBase
- IButtonPropertyItem

Index

Properties

enable id paneId typeName visible

Methods

replaceAction setIcon setTitle setTooltip

Properties

`Beta`enable

enable: boolean

Remarks

If the item is enabled in the UI.

`Readonly` `Beta`id

id: string

Remarks

Unique ID for the property item.

`Readonly` `Beta`paneId

paneId: string

Remarks

The parent pane id.

`Readonly` `Beta`typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

`Beta`visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

replaceAction

replaceAction(action: RegisteredAction<NoArgsAction>): void
Beta
Parameters
- action: RegisteredAction<NoArgsAction>
  New action to replace the existing with.
Returns void
Remarks
Replace action assigned to the button.
- Defined in tmp/package/index.d.ts:5001

setIcon

setIcon(icon: undefined | string): void
Beta
Parameters
- icon: undefined | string
  New button icon.
Returns void
Remarks
Updates icon of the button.
- Defined in tmp/package/index.d.ts:5009

setTitle

setTitle(title: undefined | LocalizedString): void
Beta
Parameters
- title: undefined | LocalizedString
  New button title.
Returns void
Remarks
Updates title of the button.
- Defined in tmp/package/index.d.ts:5017

setTooltip

setTooltip(tooltip: undefined | LocalizedString): void
Beta
Parameters
- tooltip: undefined | LocalizedString
  New button tooltip.
Returns void
Remarks
Updates tooltip description of the button.
- Defined in tmp/package/index.d.ts:5025