interface RibbonPanelType {
    addElement: (
        element: AddElementType,
    ) => Promise<null | RibbonElementType>;
    copyElementToPanel: (
        ribbonElement: RibbonElementType,
    ) => Promise<null | LPVOIDType>;
    getElementByIndex: (index: number) => Promise<null | RibbonElementType>;
    getElementByName: (
        elementName: string,
    ) => Promise<null | RibbonElementType>;
    getElementCount: () => Promise<number>;
    getName: () => Promise<string>;
    options: Options;
}

Implemented by

Properties

addElement: (element: AddElementType) => Promise<null | RibbonElementType>

向当前面板添加一个 RibbonElement 元素。

Type declaration

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);
const ribbonElement = await ribbonPanel.addElement({
elementType: FR_Ribbon_Element_Type.FR_RIBBON_BUTTON,
name: 'TestDropButton',
title: 'TestDropButton',
pos: -1
});
copyElementToPanel: (
    ribbonElement: RibbonElementType,
) => Promise<null | LPVOIDType>

将元素复制到面板。

Type declaration

    • (ribbonElement: RibbonElementType): Promise<null | LPVOIDType>
    • Parameters

      • ribbonElement: RibbonElementType

        RibbonElementType - 要复制到面板的 RibbonElementType 对象。

      Returns Promise<null | LPVOIDType>

      返回一个 Promise,该 Promise 解析为一个 LPVOIDType 对象。

getElementByIndex: (index: number) => Promise<null | RibbonElementType>

通过索引获取元素对象。

Type declaration

    • (index: number): Promise<null | RibbonElementType>
    • Parameters

      • index: number

        元素的索引。该值可通过 getElementCount 迭代获得。

      Returns Promise<null | RibbonElementType>

      获取指定的元素对象。

getElementByName: (elementName: string) => Promise<null | RibbonElementType>

根据元素名称获取 RibbonElement 元素。

Type declaration

    • (elementName: string): Promise<null | RibbonElementType>
    • Parameters

      • elementName: string

        元素的名称。

      Returns Promise<null | RibbonElementType>

      获取指定的元素对象。

getElementCount: () => Promise<number>

获取面板中的元素数量。

Type declaration

    • (): Promise<number>
    • Returns Promise<number>

      面板中元素的数量。

getName: () => Promise<string>

获取面板的名称。

Type declaration

    • (): Promise<string>
    • Returns Promise<string>

      面板的名称。

options: Options