編輯器外掛程式的自訂選單

已發布編輯器外掛程式 可以在編輯器的「擴充功能」選單下建立自訂選單項目。您可以使用 Ui.createAddonMenu() 方法插入外掛程式選單,然後使用 Menu.addItem() 方法新增項目。選單通常是在外掛程式的 onOpen(e) 方法中建立。

您可以建立動態選單,根據使用者互動或外掛程式進行調整 時間。不過,在使用者授權前,外掛程式必須先建立初始選單。因此,您必須檢查外掛程式 授權模式 才能於 onOpen(e) 中建構選單請勿嘗試採取任何行動 需要授權 (例如檢查指令碼) Properties)。 外掛程式位於 ScriptApp.AuthMode.NONE 時。詳情請參閱 授權生命週期

以下範例說明如何為 授權模式:

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