Class RibbonElement

Implements

Methods

addSubItem getSubElementByName setEnabled setExecuteProc setTooltip

Methods

addSubItem

  • addSubItem(subItem: AddSubItemType): Promise<null | LPVOIDType>

    Add a sub item to the parent element.

    Parameters

    Returns Promise<null | LPVOIDType>

    The LPVOID obj added to the parent element.

    Example

    const ribbonBar = await app.getRibbonBar();
    const ribbonCategory = await ribbonBar.addCategory('categoryName', 'categoryTitle');
    const ribbonPanel = await ribbonCategory.addPanel('panelName', 'panelTitle', btnBitmap);
    const ribbonElement = await ribbonPanel.addElement('elementName', 'elementTitle', btnBitmap);
    const subribbonElement = await btnElement.addSubItem({
        elementType: 0,
        name: 'SubItem1',
        title: 'SubItem1',
        pos: -1,
        isOnTop: true,
        isChangeFun: false,
        isChangeImage: false
     });

getSubElementByName

setEnabled

  • setEnabled(enable?: boolean): Promise<void>

    Set the ribbon element to be disabled or enabled.

    Parameters

    • enable: boolean = false

      Whether the compute function is enabled.

    Returns Promise<void>

setExecuteProc

  • setExecuteProc(proc: ExecuteProcCallbacksType): Promise<void>

    Set execute proc callback , which is called when the element is clicked.

    Parameters

    Returns Promise<void>

    Example

    let executeProc = {
         onExecute: async (clientData: LPVOID) => {
             console.log('This is a button', clientData);
         }
    };
    await btnElement.setExecuteProc(executeProc);

setTooltip

  • setTooltip(tooltip: string): Promise<void>

    Set the tooltip information.

    Parameters

    • tooltip: string

      The tooltip information.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods