Class Menu

菜单

Google 应用的用户界面实例中的自定义菜单。脚本只能与当前打开的文档或表单实例的界面进行交互,并且前提是该脚本绑定到容器文档或表单。如需了解详情,请参阅菜单指南

// 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();
}

方法

方法返回类型简介
addItem(caption, functionName)Menu向菜单添加项。
addSeparator()Menu向菜单添加视觉分隔符。
addSubMenu(menu)Menu向菜单添加子菜单。
addToUi()void将菜单插入到编辑器用户界面的实例中。

详细文档

addItem(caption, functionName)

向菜单添加项。菜单项的标签应采用句首字母大写形式(只有第一个字词的首字母大写)。

参数

名称类型说明
captionString菜单项的标签,只有第一个字词的首字母大写。
functionNameString当用户选择相应项时要调用的函数的名称。您可以使用所含库中的函数,例如 Library.libFunction1

返回

Menu - 此 Menu,用于链式调用。


addSeparator()

向菜单添加视觉分隔符。

返回

Menu - 此 Menu,用于链式调用。


addSubMenu(menu)

向菜单添加子菜单。

参数

名称类型说明
menuMenu子菜单,其结构与顶级菜单类似。

返回

Menu - 此 Menu,用于链式调用。


addToUi()

将菜单插入到编辑器用户界面的实例中。