编辑器插件的自定义菜单

已发布的编辑器插件可以在其编辑器的扩展程序菜单下创建自定义菜单项。您可以使用 Ui.createAddonMenu() 方法插入插件菜单,并使用 Menu.addItem() 方法向其中添加菜单项。菜单通常在插件的 onOpen(e) 方法中创建。

您可以创建根据用户互动或插件状态而变化的动态菜单。不过,插件必须在用户授权之前创建初始菜单。因此,您必须先检查插件的授权模式,然后才能在 onOpen(e) 中构建菜单。当插件位于 ScriptApp.AuthMode.NONE 中时,请勿尝试执行任何需要授权的操作(例如检查脚本 Properties)。如需详细了解授权模式和生命周期,请参阅授权生命周期

以下示例展示了如何为不同的授权模式构建动态插件菜单:

function onOpen(e) {
  var menu = SpreadsheetApp.getUi().createAddonMenu(); // Or DocumentApp or SlidesApp or FormApp.
  if (e && e.authMode == ScriptApp.AuthMode.NONE) {
    // Add a normal menu item (works in all authorization modes).
    menu.addItem('Start workflow', 'startWorkflow');
  } else {
    // Add a menu item based on properties (doesn't work in AuthMode.NONE).
    var properties = PropertiesService.getDocumentProperties();
    var workflowStarted = properties.getProperty('workflowStarted');
    if (workflowStarted) {
      menu.addItem('Check workflow status', 'checkWorkflow');
    } else {
      menu.addItem('Start workflow', 'startWorkflow');
    }
    // Record analytics.
    UrlFetchApp.fetch('http://www.example.com/analytics?event=open');
  }
  menu.addToUi();
}