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 IU para a instância atual de um documento ou formulário aberto e somente se o script for vinculado ao contêiner no documento ou 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 em letra maiúscula (somente a primeira palavra em letras maiúsculas).

Parâmetros

NomeTipoDescrição
captionStringA etiqueta do item de menu, com apenas a primeira palavra em maiúsculo.
functionNameStringNome da função a ser invocada quando o usuário selecionar o item. É possível usar funções de bibliotecas incluídas, como Library.libFunction1.

Retornar

Menu: este Menu para encadeamento.


addSeparator()

Adiciona um separador visual ao menu.

Retornar

Menu: este Menu para encadeamento.


addSubMenu(menu)

Adiciona um submenu ao menu.

Parâmetros

NomeTipoDescrição
menuMenuSubmenu criado como um menu de nível superior.

Retornar

Menu: este Menu para encadeamento.


addToUi()

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