Interface RibbonBarType

interface RibbonBarType {
    addCategory: (
        name: string,
        title: string,
    ) => Promise<null | RibbonCategoryType>;
    findElementByName: (
        categoryName: string,
        panelName: string,
        btnName: string,
    ) => Promise<null | RibbonElementType>;
    getActiveCategory: () => Promise<null | RibbonCategoryType>;
    getCategoryByIndex: (index: number) => Promise<null | RibbonCategoryType>;
    getCategoryByName: (
        categoryName: string,
    ) => Promise<null | RibbonCategoryType>;
    getCategoryCount: () => Promise<number>;
    reCalcLayout: (reCalcPanels: boolean) => Promise<void>;
    setActiveCategory: (categoryName: string) => Promise<boolean>;
}

Implemented by

Properties

addCategory findElementByName getActiveCategory getCategoryByIndex getCategoryByName getCategoryCount reCalcLayout setActiveCategory

Properties

addCategory

addCategory: (name: string, title: string) => Promise<null | RibbonCategoryType>

向功能区添加一个类别。

Type declaration

    • (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');

findElementByName

findElementByName: (
    categoryName: string,
    panelName: string,
    btnName: string,
) => Promise<null | RibbonElementType>

通过类别、面板和元素的名称查找 RibbonElement 对象。

Type declaration

    • (
          categoryName: string,
          panelName: string,
          btnName: string,
      ): Promise<null | RibbonElementType>

    • Parameters

      • categoryName: string

        类别名称，用于指定所需的类别。

      • panelName: string

        面板名称，用于指定所需的面板。

      • btnName: string

        元素名称，用于指定所需的元素。

      Returns Promise<null | RibbonElementType>

      • 获取指定的 RibbonElement 对象。

getActiveCategory

getActiveCategory: () => Promise<null | RibbonCategoryType>

获取当前激活的分类。

Type declaration

getCategoryByIndex

getCategoryByIndex: (index: number) => Promise<null | RibbonCategoryType>

通过索引获取分类对象。

Type declaration

    • (index: number): Promise<null | RibbonCategoryType>

    • Parameters

      • index: number

        分类的索引。该值可以通过 getCategoryCount 进行遍历。

      Returns Promise<null | RibbonCategoryType>

      获取指定的分类对象。

Example

const parentWnd = await LPVOID.create();
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);
}

getCategoryByName

getCategoryByName: (categoryName: string) => Promise<null | RibbonCategoryType>

通过名称获取分类对象。

Type declaration

getCategoryCount

getCategoryCount: () => Promise<number>

获取功能区中类别的数量。

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

      功能区中类别的数量。

Example

const parentWnd = await LPVOID.create();
const ribbonBar = await app.getRibbonBar(parentWnd);
const categoryCount = await ribbonBar.getCategoryCount();

reCalcLayout

reCalcLayout: (reCalcPanels: boolean) => Promise<void>

重新计算功能区栏的布局。

Type declaration

    • (reCalcPanels: boolean): Promise<void>

    • Parameters

      • reCalcPanels: boolean

        是否重新计算面板的布局。

      Returns Promise<void>

setActiveCategory

setActiveCategory: (categoryName: string) => Promise<boolean>

设置要激活的分类名称。

Type declaration

    • (categoryName: string): Promise<boolean>

    • Parameters

      • categoryName: string

        需要被激活的分类名称。

      Returns Promise<boolean>

      • 分类是否成功激活。

Settings

Member Visibility

On This Page

Properties