Interface IButtonPropertyItem

A property item which supports Button properties

Hierarchy

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): void
Parameters
- action: RegisteredAction<NoArgsAction>
  
  New action to replace the existing with.
Returns void

Remarks
Replace action assigned to the button.

setIcon

setIcon(icon): void
Parameters
- icon: string
  
  New button icon.
Returns void

Remarks
Updates icon of the button.

setTitle

setTitle(title): void
Parameters
- title: LocalizedString
  
  New button title.
Returns void

Remarks
Updates title of the button.

setTooltip

setTooltip(tooltip): void
Parameters
- tooltip: LocalizedString
  
  New button tooltip.
Returns void

Remarks
Updates tooltip description of the button.