Class RibbonBar

Implements

RibbonBarType

Index

Methods

addCategory findElementByName getActiveCategory getCategoryByIndex getCategoryByName getCategoryCount reCalcLayout setActiveCategory

Methods

addCategory

addCategory(name: string, title: string): Promise<null | RibbonCategoryType>
向功能区栏添加一个类别。
Parameters
- name: string
  类别名称，用于标识特定类别。
- title: string
  类别标题，用于显示该类别。
Returns Promise<null | RibbonCategoryType>
添加到功能区栏的 RibbonCategory 对象。
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>
通过类别、面板和元素的名称查找 RibbonElement 对象。
Parameters
- categoryName: string
  类别名称，用于指定所需的类别。
- panelName: string
  面板名称，用于指定所需的面板。
- btnName: string
  元素名称，用于指定所需的元素。
Returns Promise<null | RibbonElementType>
- 获取指定的 RibbonElement 对象。
Implementation of RibbonBarType.findElementByName

getActiveCategory

getActiveCategory(): Promise<null | RibbonCategoryType>
获取当前激活的分类。

Returns Promise<null | RibbonCategoryType>
- 当前激活的分类对象。
Implementation of RibbonBarType.getActiveCategory

getCategoryByIndex

getCategoryByIndex(index: number): Promise<null | RibbonCategoryType>
通过索引获取类别对象。
Parameters
- index: number
  类别的索引。该值可以通过 getCategoryCount 迭代获取。
Returns Promise<null | RibbonCategoryType>
获取指定的类别对象。
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>
通过名称获取分类对象。
Parameters
- categoryName: string
  分类的名称。
Returns Promise<null | RibbonCategoryType>
- 获取指定的分类对象。
Implementation of RibbonBarType.getCategoryByName

getCategoryCount

getCategoryCount(): Promise<number>
获取功能区栏中的类别数量。

Returns Promise<number>
功能区栏中类别的数量。
Example
```
const ribbonBar = await app.getRibbonBar(parentWnd);
const categoryCount = await ribbonBar.getCategoryCount();
```
Implementation of RibbonBarType.getCategoryCount

reCalcLayout

reCalcLayout(reCalcPanels?: boolean): Promise<void>
重新计算功能区栏的布局。
Parameters
- reCalcPanels: boolean = true
  是否重新计算面板的布局。
Returns Promise<void>
Implementation of RibbonBarType.reCalcLayout

setActiveCategory

setActiveCategory(categoryName: string): Promise<boolean>
通过名称设置激活的类别。
Parameters
- categoryName: string
  需要被激活的类别名称。
Returns Promise<boolean>
- 该类别是否已成功激活。
Implementation of RibbonBarType.setActiveCategory