Class Ui

在用户编辑器中打开一个对话框，其中包含给定消息和“确定”按钮。此方法会在对话框打开时暂停服务器端脚本。脚本会在用户关闭对话框后继续运行，但 Jdbc 连接和 LockService 锁定在暂停期间不会保留。如需了解详情，请参阅对话框和边栏指南。

// Display "Hello, world" in a dialog box with an "OK" button. The user can also close the
// dialog by clicking the close button in its title bar.
SpreadsheetApp.getUi().alert('Hello, world');

参数

返程

Button - 用户点击的按钮。

在用户编辑器中打开一个对话框，其中包含指定的消息和一组按钮。此方法会在对话框打开时暂停服务器端脚本。脚本会在用户关闭对话框后继续运行，但 Jdbc 连接和 LockService 锁定在暂停期间不会保留。如需了解详情，请参阅对话框和边栏指南。

// Display a dialog box with a message and "Yes" and "No" buttons. The user can also close the
// dialog by clicking the close button in its title bar.
var ui = SpreadsheetApp.getUi();
var response = ui.alert('Are you sure you want to continue?', ui.ButtonSet.YES_NO);

// Process the user's response.
if (response == ui.Button.YES) {
  Logger.log('The user clicked "Yes."');
} else {
  Logger.log('The user clicked "No" or the close button in the dialog\'s title bar.');
}

参数

返程

Button - 用户点击的按钮。

在用户编辑器中打开一个对话框，其中包含指定标题、消息和一组按钮。此方法会在对话框打开时暂停服务器端脚本。脚本会在用户关闭对话框后继续运行，但 Jdbc 连接和 LockService 锁定在暂停期间不会保留。如需了解详情，请参阅对话框和边栏指南。

// Display a dialog box with a title, message, and "Yes" and "No" buttons. The user can also
// close the dialog by clicking the close button in its title bar.
var ui = SpreadsheetApp.getUi();
var response = ui.alert('Confirm', 'Are you sure you want to continue?', ui.ButtonSet.YES_NO);

// Process the user's response.
if (response == ui.Button.YES) {
  Logger.log('The user clicked "Yes."');
} else {
  Logger.log('The user clicked "No" or the close button in the dialog\'s title bar.');
}

参数

返程

Button - 用户点击的按钮。

创建一个构建器，该构建器可用于将子菜单插入编辑器的“Extensions”菜单中。除非调用 Menu.addToUi()，否则菜单实际上不会更新。如果脚本作为插件运行，则子菜单名称与该插件在应用商店中的名称一致；如果脚本直接绑定到文档，则子菜单名称与该脚本的名称一致。如需了解详情，请参阅菜单指南。

// Add an item to the Add-on menu, under a sub-menu whose name is set automatically.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createAddonMenu()
      .addItem('Show', 'showSidebar')
      .addToUi();
}

返程

Menu - 新的菜单构建器。

创建一个构建器，该构建器可用于将菜单添加到编辑器的界面。实际上，只有在调用 Menu.addToUi() 之后，该菜单才会添加。如需了解详情，请参阅菜单指南。顶级菜单的标签应采用首字母大写形式（所有主要单词的首字母大写），而子菜单的标签应采用句首字母大写形式（只有第一个单词的首字母大写）。如果脚本是作为插件发布的，系统会忽略 caption 参数，并将菜单添加为“扩展程序”菜单的子菜单，相当于 createAddonMenu()。

// Add a custom menu to the active document, 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 sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

参数

返程

Menu - 新的菜单构建器。

在用户编辑器中打开包含给定消息和“确定”按钮的输入对话框。此方法会在对话框打开时暂停服务器端脚本。脚本会在用户关闭对话框后继续运行，但 Jdbc 连接和 LockService 锁定在暂停期间不会保留。如需了解详情，请参阅对话框和边栏指南。

// Display a dialog box with a message, input field, and an "OK" button. The user can also
// close the dialog by clicking the close button in its title bar.
var ui = SpreadsheetApp.getUi();
var response = ui.prompt('Enter your name:');

// Process the user's response.
if (response.getSelectedButton() == ui.Button.OK) {
  Logger.log('The user\'s name is %s.', response.getResponseText());
} else {
  Logger.log('The user clicked the close button in the dialog\'s title bar.');
}

参数

返程

PromptResponse - 用户响应的表示形式。

在用户的编辑器中打开一个输入对话框，其中包含指定的消息和一组按钮。此方法会在对话框打开时暂停服务器端脚本。脚本会在用户关闭对话框后继续运行，但 Jdbc 连接和 LockService 锁定在暂停期间不会保留。如需了解详情，请参阅对话框和边栏指南。

// Display a dialog box with a message, input field, and "Yes" and "No" buttons. The user can
// also close the dialog by clicking the close button in its title bar.
var ui = SpreadsheetApp.getUi();
var response = ui.prompt('May I know your name?', ui.ButtonSet.YES_NO);

// Process the user's response.
if (response.getSelectedButton() == ui.Button.YES) {
  Logger.log('The user\'s name is %s.', response.getResponseText());
} else if (response.getSelectedButton() == ui.Button.NO) {
  Logger.log('The user didn\'t want to provide a name.');
} else {
  Logger.log('The user clicked the close button in the dialog\'s title bar.');
}

参数

返程

PromptResponse - 用户响应的表示形式。

在用户的编辑器中打开一个输入对话框，其中包含给定的标题、消息和一组按钮。此方法会在对话框打开时暂停服务器端脚本。脚本会在用户关闭对话框后恢复，但 Jdbc 连接和 LockService 锁定在暂停期间不会持续存在。如需了解详情，请参阅对话框和边栏指南。

// Display a dialog box with a title, message, input field, and "Yes" and "No" buttons. The
// user can also close the dialog by clicking the close button in its title bar.
var ui = SpreadsheetApp.getUi();
var response = ui.prompt('Getting to know you', 'May I know your name?', ui.ButtonSet.YES_NO);

// Process the user's response.
if (response.getSelectedButton() == ui.Button.YES) {
  Logger.log('The user\'s name is %s.', response.getResponseText());
} else if (response.getSelectedButton() == ui.Button.NO) {
  Logger.log('The user didn\'t want to provide a name.');
} else {
  Logger.log('The user clicked the close button in the dialog\'s title bar.');
}

参数

返程

PromptResponse - 用户响应的表示形式。

在用户编辑器中打开一个模态对话框，其中包含自定义客户端内容。对话框打开时，此方法不会挂起服务器端脚本。为了与服务器端脚本通信，客户端组件必须使用 HtmlService 的 google.script API 进行异步回调。如需以编程方式关闭对话框，请在 HtmlService Web 应用的客户端上调用 google.script.host.close()。如需了解详情，请参阅对话框和边栏指南。

模态对话框可防止用户与对话框以外的任何内容互动。相比之下，不受限制的对话框和边栏可让用户与编辑器互动。在几乎所有情况下，模态对话框或边栏都是比非模态对话框更好的选择。

// Display a modal dialog box with custom HtmlService content.
var htmlOutput = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setWidth(250)
    .setHeight(300);
SpreadsheetApp.getUi().showModalDialog(htmlOutput, 'My add-on');

参数

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/script.container.ui

在用户的编辑器中打开一个非模态对话框，其中包含自定义客户端内容。对话框打开时，此方法不会挂起服务器端脚本。为了与服务器端脚本通信，客户端组件必须使用 HtmlService 的 google.script API 进行异步回调。如需以编程方式关闭对话框，请在 HtmlService Web 应用的客户端上调用 google.script.host.close()。如需了解详情，请参阅对话框和边栏指南。

非模态对话框可让用户与对话框背后的编辑器互动。相比之下，模态对话框则不支持。几乎在所有情况下，模态对话框或边栏都比非模态对话框是更好的选择。

// Display a modeless dialog box with custom HtmlService content.
var htmlOutput = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setWidth(250)
    .setHeight(300);
SpreadsheetApp.getUi().showModelessDialog(htmlOutput, 'My add-on');

参数

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/script.container.ui

在用户编辑器中打开边栏，显示自定义客户端内容。当边栏打开时，此方法不会挂起服务器端脚本。为了与服务器端脚本通信，客户端组件必须使用 HtmlService 的 google.script API 进行异步回调。如需以编程方式关闭边栏，请在 HtmlService Web 应用的客户端上调用 google.script.host.close()。如需了解详情，请参阅对话框和边栏指南。

如果用户的环境使用从左到右书写的语言，边栏会显示在编辑器的右侧；对于从右到左书写的语言，边栏会显示在编辑器的左侧。由文字显示的所有边栏均为 300 像素宽。

// Display a sidebar with custom HtmlService content.
var htmlOutput = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My add-on');
SpreadsheetApp.getUi().showSidebar(htmlOutput);

参数

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

• https://www.googleapis.com/auth/script.container.ui