Class Menu

Menu

Um menu personalizado em uma instância da interface do usuário de um Google app. Um script só pode interagir com a interface da instância atual de um documento ou formulário aberto e somente se o script estiver vinculado ao contêiner ao documento ou ao formulário. Para mais informações, consulte o guia de menus.

// Add a custom menu to the active spreadsheet, including a separator and a sub-menu.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createMenu('My Menu')
      .addItem('My Menu Item', 'myFunction')
      .addSeparator()
      .addSubMenu(SpreadsheetApp.getUi().createMenu('My Submenu')
          .addItem('One Submenu Item', 'mySecondFunction')
          .addItem('Another Submenu Item', 'myThirdFunction'))
      .addToUi();
}

Métodos

MétodoTipo de retornoBreve descrição
addItem(caption, functionName)MenuAdiciona um item ao menu.
addSeparator()MenuAdiciona um separador visual ao menu.
addSubMenu(menu)MenuAdiciona um submenu ao menu.
addToUi()voidInsere o menu na instância da interface do usuário do editor.

Documentação detalhada

addItem(caption, functionName)

Adiciona um item ao menu. O rótulo de um item de menu precisa estar com a primeira letra maiúscula.

Parâmetros

NomeTipoDescrição
captionStringO rótulo do item de menu, com apenas a primeira palavra em maiúscula.
functionNameStringO nome da função a ser invocada quando o usuário selecionar o item. Você pode usar funções de bibliotecas incluídas, como Library.libFunction1.

Retorno

Menu: este Menu, para encadeamento.


addSeparator()

Adiciona um separador visual ao menu.

Retorno

Menu: este Menu, para encadeamento.


addSubMenu(menu)

Adiciona um submenu ao menu.

Parâmetros

NomeTipoDescrição
menuMenuO submenu, construído como um menu de nível superior.

Retorno

Menu: este Menu, para encadeamento.


addToUi()

Insere o menu na instância da interface do usuário do editor.