Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RibbonPanel

Represents ribbon panels in ribbon category.

A ribbon panel contains several ribbon elements, which can be a button, a file selecotr or a dropdown list.

Use RibbonCategory.getPanelByIndex or RibbonCategory.getPanelByName to get an existing ribbon panel.
Use RibbonCategory.addPanel to add a ribbon panel to a ribbon category.

Hierarchy

  • RibbonPanel

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

fxRibbonPanel

fxRibbonPanel: fxRibbonPanel

Methods

addElement

  • Add a button ribbon element to the ribbon panel.

    Parameters

    Returns Promise<RibbonEleButton>

  • Add a icon-list ribbon element to the ribbon panel.

    Parameters

    Returns Promise<RibbonEleIconList>

  • Add a file selector ribbon element to the ribbon panel.

    Parameters

    Returns Promise<RibbonEleFile>

getElementByIndex

  • getElementByIndex(index: number): Promise<null | RibbonElement>

  • Get a ribbon element by index in the ribbon panel.

    Parameters

    • index: number

    Returns Promise<null | RibbonElement>

getElementByName

  • Get a ribbon element by name in the ribbon panel.

    Parameters

    • name: string

    Returns Promise<null | RibbonElement>

getElementCount

  • getElementCount(): Promise<number>

  • Get the count of ribbon element in the ribbon panel.

    Returns Promise<number>