Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RibbonBar

Represents the ribbon bar in the top of the app.

The app has only one ribbon bar, and the ribbon bar has several ribbon categories, and ribbon categories can be switched between each other by clicking the button in the ribbon bar.

To get the ribbon bar, please use:

const ribbonBar = Foxit.ReaderApp.getRibbonBar();

Hierarchy

  • RibbonBar

Index

Methods

Methods

addCategory

  • addCategory(name: string, title: string, position: number): Promise<RibbonCategory>

  • Add a ribbon category to the ribbon bar.

    Parameters

    • name: string
    • title: string
    • position: number

    Returns Promise<RibbonCategory>

getCategoryByIndex

  • Get a ribbon category by index.

    Parameters

    • index: number

    Returns Promise<RibbonCategory>

getCategoryByName

  • getCategoryByName(name: string): Promise<undefined | RibbonCategory>

  • Get a ribbon category by name.

    Parameters

    • name: string

    Returns Promise<undefined | RibbonCategory>

getCategoryCount

  • getCategoryCount(): Promise<number>

  • Get the category count in the ribbon bar.

    Returns Promise<number>