Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RibbonElement

Represents the ribbon element in the ribbon bar.

Use RibbonPanel.getElementByIndex or RibbonPanel.getElementByName to get an existing ribbon element.
Use RibbonPanel.addElement to add a new ribbon element.

see

RibbonPanel

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

activate

  • activate(): Promise<void>

  • Activate the ribbon element.
    If a ribbon element is activated, its background will be darker.

    Returns Promise<void>

deactivate

  • deactivate(): Promise<void>

  • Deactivate the ribbon element.

    Returns Promise<void>

disable

  • disable(): Promise<void>

  • Disable the ribbon element.

    Returns Promise<void>

enable

  • enable(): Promise<void>

  • Enable the ribbon element.

    Returns Promise<void>

getTooltip

  • getTooltip(): Promise<string>

  • Get the tool tip of the ribbon element.

    Returns Promise<string>

isActivate

  • isActivate(): Promise<boolean>

  • Check the ribbon isActivate.

    Returns Promise<boolean>

isEnabled

  • isEnabled(): Promise<boolean>

  • Get if the ribbon element is enable. If a ribbon element is disabled, it can be clicked and its color turned grey.

    Returns Promise<boolean>

setDescription

  • setDescription(description: string): Promise<void>

  • Set the description of the ribbon element.

    Parameters

    • description: string

    Returns Promise<void>

setTooltip

  • setTooltip(tooltip: string): Promise<void>

  • Set the tool tip of the ribbon element.

    Parameters

    • tooltip: string

    Returns Promise<void>