Class Menu

Menu

Um menu personalizado em uma instância da interface do usuário de um app do Google. 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 do 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étodo	Tipo de retorno	Breve descrição
addItem(caption, functionName)	Menu	Adiciona um item ao menu.
addSeparator()	Menu	Adiciona um separador visual ao menu.
addSubMenu(menu)	Menu	Adiciona um submenu ao menu.
addToUi()	void	Insere 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 maiúscula (apenas a primeira palavra em maiúscula).

Parâmetros

Nome	Tipo	Descrição
caption	String	O rótulo do item do menu, com apenas a primeira palavra em maiúscula.
functionName	String	O nome 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: Menu para encadeamento.

---

addSeparator()

Adiciona um separador visual ao menu.

Retornar

Menu: Menu para encadeamento.

---

addSubMenu(menu)

Adiciona um submenu ao menu.

Parâmetros

Nome	Tipo	Descrição
menu	Menu	O submenu, construído como um menu de nível superior.

Retornar

Menu: Menu para encadeamento.

---

addToUi()

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