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>
Add a panel to the category.
Parameters
- name: string
  The name of the panel, used to identify a specific panel.
- title: string
  The title of the panel, used to display the panel.
- btnBitmap: DIBitmapType
  The bitmap of the panel, used to display the panel.
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>
Copy a panel from the category.
Parameters
- ribbonPanel: RibbonPanelType
  The panel to be copied.
Returns Promise<null | RibbonPanelType>
The copied panel.

Implementation of RibbonCategoryType.copyPanel

getName

getName(): Promise<string>
Get the name of the category.

Returns Promise<string>
The name of the category.

Implementation of RibbonCategoryType.getName

getPanelByIndex

getPanelByIndex(index: number): Promise<null | RibbonPanelType>
Get the panel object by index.
Parameters
- index: number
  The index of the panel. This value can be iterated through from getPanelCount.
Returns Promise<null | RibbonPanelType>
Get the specified panel object.

Implementation of RibbonCategoryType.getPanelByIndex

getPanelByName

getPanelByName(panelName: string): Promise<null | RibbonPanelType>
Get the panel object by name.
Parameters
- panelName: string
  The name of the panel.
Returns Promise<null | RibbonPanelType>
Get the specified panel object.
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>
Get the number of panels in the category.

Returns Promise<number>
The number of panels in the category.

Implementation of RibbonCategoryType.getPanelCount

reCalcLayout

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

Implementation of RibbonCategoryType.reCalcLayout