Class RibbonCategory

Implements

RibbonCategoryType

Index

Methods

addPanel copyPanel getName getPanelByIndex getPanelByName getPanelCount reCalcLayout

Methods

addPanel

addPanel(
    name: string,
    title: string,
    btnBitmap: DIBitmapType,
): Promise<null | RibbonPanelType>
向类别中添加一个面板。
Parameters
- name: string
  面板名称，用于标识特定面板。
- title: string
  面板标题，用于显示面板。
- btnBitmap: DIBitmapType
  面板的位图，用于显示面板。
Returns Promise<null | RibbonPanelType>
Example
```
const parentWnd = await LPVOID.create();
const ribbonBar = await app.getRibbonBar(parentWnd);
const ribbonCategory = await ribbonBar.addCategory('categoryName', 'categoryTitle');
const ribbonPanel = await ribbonCategory.addPanel('panelName', 'panelTitle', btnBitmap);
```
Implementation of RibbonCategoryType.addPanel

copyPanel

copyPanel(ribbonPanel: RibbonPanelType): Promise<null | RibbonPanelType>
从类别中复制一个面板。
Parameters
- ribbonPanel: RibbonPanelType
  要复制的面板。
Returns Promise<null | RibbonPanelType>
复制得到的面板。

Implementation of RibbonCategoryType.copyPanel

getName

getName(): Promise<string>
获取类别的名称。

Returns Promise<string>
类别的名称。

Implementation of RibbonCategoryType.getName

getPanelByIndex

getPanelByIndex(index: number): Promise<null | RibbonPanelType>
通过索引获取面板对象。
Parameters
- index: number
  面板的索引。该值可以通过 getPanelCount 迭代获取。
Returns Promise<null | RibbonPanelType>
获取指定的面板对象。

Implementation of RibbonCategoryType.getPanelByIndex

getPanelByName

getPanelByName(panelName: string): Promise<null | RibbonPanelType>
根据名称获取面板对象。
Parameters
- panelName: string
  面板名称。
Returns Promise<null | RibbonPanelType>
获取指定的面板对象。
Example
```
const parentWnd = await LPVOID.create();
const ribbonBar = await app.getRibbonBar(parentWnd);
const ribbonCategory = await ribbonBar.getCategoryByName('categoryName');
const ribbonPanel = await ribbonCategory.getPanelByName('panelName');
```
Implementation of RibbonCategoryType.getPanelByName

getPanelCount

getPanelCount(): Promise<number>
获取类别中的面板数量。

Returns Promise<number>
类别中面板的数量。

Implementation of RibbonCategoryType.getPanelCount

reCalcLayout

reCalcLayout(reCalcPanels?: boolean): Promise<void>
重新计算分类的布局。
Parameters
- reCalcPanels: boolean = true
  是否重新计算面板的布局。
Returns Promise<void>
Promise

Implementation of RibbonCategoryType.reCalcLayout