Class RibbonBar

Implements

RibbonBarType

Index

Methods

addCategory findElementByName getActiveCategory getCategoryByIndex getCategoryByName getCategoryCount reCalcLayout setActiveCategory

Methods

addCategory

addCategory(name: string, title: string): Promise<null | RibbonCategoryType>
Add a category to the ribbon bar.
Parameters
- name: string
  The name of the category, used to identify a specific category.
- title: string
  The title of the category, used to display the category.
Returns Promise<null | RibbonCategoryType>
The RibbonCategory obj added to the ribbon bar.
Example
```
const ribbonBar = await app.getRibbonBar(parentWnd);
const ribbonCategory = await ribbonBar.addCategory('categoryName', 'categoryTitle');
```
Implementation of RibbonBarType.addCategory

findElementByName

findElementByName(
    categoryName: string,
    panelName: string,
    btnName: string,
): Promise<null | RibbonElementType>
Find the RibbonElement object by the name of the category, panel, and element.
Parameters
- categoryName: string
  The name of the category, used to specify the required category.
- panelName: string
  The name of the panel, used to specify the required panel.
- btnName: string
  The name of the element, used to specify the required element.
Returns Promise<null | RibbonElementType>
- Get the specified RibbonElement object.
Implementation of RibbonBarType.findElementByName

getActiveCategory

getActiveCategory(): Promise<null | RibbonCategoryType>
Get the active category.

Returns Promise<null | RibbonCategoryType>
- The active category object.
Implementation of RibbonBarType.getActiveCategory

getCategoryByIndex

getCategoryByIndex(index: number): Promise<null | RibbonCategoryType>
Get the category object by index.
Parameters
- index: number
  The index of the category. This value can be iterated through from getCategoryCount.
Returns Promise<null | RibbonCategoryType>
Get the specified category object.
Example
```
const ribbonBar = await app.getRibbonBar(parentWnd);
const categoryCount = await ribbonBar.getCategoryCount(0);
for (let i = 0; i < categoryCount; i++) {
   const ribbonCategory = await ribbonBar.getCategoryByIndex(i);
}
```
Implementation of RibbonBarType.getCategoryByIndex

getCategoryByName

getCategoryByName(categoryName: string): Promise<null | RibbonCategoryType>
Get the category object by name.
Parameters
- categoryName: string
  The name of the category.
Returns Promise<null | RibbonCategoryType>
- Get the specified category object.
Implementation of RibbonBarType.getCategoryByName

getCategoryCount

getCategoryCount(): Promise<number>
Get the number of categories in the ribbon bar.

Returns Promise<number>
The number of categories in the ribbon bar.
Example
```
const ribbonBar = await app.getRibbonBar(parentWnd);
const categoryCount = await ribbonBar.getCategoryCount();
```
Implementation of RibbonBarType.getCategoryCount

reCalcLayout

reCalcLayout(reCalcPanels?: boolean): Promise<void>
Recalculate the layout of the ribbon bar.
Parameters
- reCalcPanels: boolean = true
  Whether to recalculate the layout of the panel.
Returns Promise<void>
Implementation of RibbonBarType.reCalcLayout

setActiveCategory

setActiveCategory(categoryName: string): Promise<boolean>
Set the active category by name.
Parameters
- categoryName: string
  The name of the category that needs to be activated.
Returns Promise<boolean>
- Whether the category is activated successfully.
Implementation of RibbonBarType.setActiveCategory