Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RibbonCategory

Represents ribbon categories in the ribbon bar.

A ribbon categories contains several ribbon panels, and these ribbon panels are seperated by line from each other.

Use RibbonBar.getCategoryByIndex or RibbonBar.getCategoryByName to get an existing ribbon category.
Use RibbonBar.addCategory to add a ribbon category to a ribbon bar.

Hierarchy

  • RibbonCategory

Index

Methods

Methods

addPanel

  • addPanel(name: string, title: string): Promise<null | RibbonPanel>

  • Add a ribbon panel to the ribbon category

    Parameters

    • name: string
    • title: string

    Returns Promise<null | RibbonPanel>

getName

  • getName(): Promise<string>

  • Get the name of the ribbon category.

    Returns Promise<string>

getPanelByIndex

  • Get a ribbon panel by index.

    Parameters

    • index: number

    Returns Promise<RibbonPanel>

getPanelByName

  • getPanelByName(name: string): Promise<null | RibbonPanel>

  • Get a ribbon panel by index.

    Parameters

    • name: string

    Returns Promise<null | RibbonPanel>

getPanelCount

  • getPanelCount(): Promise<number>

  • Get the count of ribbon panels in the ribbon category.

    Returns Promise<number>

getTitle

  • getTitle(): Promise<string>

  • Get the title of the ribbon category.

    Returns Promise<string>

setTitle

  • setTitle(title: string): Promise<string>

  • Set the title of the ribbon category.

    Parameters

    • title: string

    Returns Promise<string>