Class Ui

Abre un cuadro de diálogo en el editor del usuario con el mensaje dado y un botón "Aceptar". Este método suspende la secuencia de comandos del servidor mientras el diálogo está abierto. La secuencia de comandos se reanuda después de que el usuario descarta el diálogo, pero las conexiones Jdbc y los bloqueos de LockService no persisten durante la suspensión. Para obtener más información, consulta la guía de diálogos y barras laterales.

// 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');

Parámetros

Volver

Button: Es el botón en el que el usuario hizo clic.

Abre un cuadro de diálogo en el editor del usuario con el mensaje y el conjunto de botones especificados. Este método suspende la secuencia de comandos del servidor mientras el diálogo está abierto. La secuencia de comandos se reanuda después de que el usuario descarta el diálogo, pero las conexiones Jdbc y los bloqueos de LockService no persisten durante la suspensión. Para obtener más información, consulta la guía de diálogos y barras laterales.

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

Parámetros

Volver

Button: Es el botón en el que el usuario hizo clic.

Abre un cuadro de diálogo en el editor del usuario con el título, el mensaje y el conjunto de botones especificados. Este método suspende la secuencia de comandos del servidor mientras el diálogo está abierto. La secuencia de comandos se reanuda después de que el usuario descarta el diálogo, pero las conexiones Jdbc y los bloqueos LockService no persisten durante la suspensión. Para obtener más información, consulta la guía de diálogos y barras laterales.

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

Parámetros

Volver

Button: Es el botón en el que el usuario hizo clic.

Crea un compilador que se puede usar para insertar un submenú en el menú Extensiones del editor. En realidad, el menú no se actualizará hasta que se llame a Menu.addToUi(). Si la secuencia de comandos se ejecuta como un complemento, el nombre del submenú coincide con el nombre del complemento en la tienda web. Si la secuencia de comandos está vinculada al documento de forma directa, el nombre del submenú coincide con el nombre de la secuencia de comandos. Para obtener más información, consulta la guía de menús.

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

Volver

Menu: Es el nuevo creador de menús.

Crea un compilador que se puede usar para agregar un menú a la interfaz de usuario del editor. En realidad, no se agregará el menú hasta que se llame a Menu.addToUi(). Para obtener más información, consulta la guía de menús. La etiqueta de un menú de nivel superior debe estar en mayúsculas (todas las palabras principales están en mayúscula), aunque la etiqueta de un submenú debe estar en mayúscula inicial (solo la primera palabra en mayúscula). Si la secuencia de comandos se publica como un complemento, se ignora el parámetro caption y se agrega el menú como submenú del menú Extensiones, que equivale a 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();
}

Parámetros

Volver

Menu: Es el nuevo creador de menús.

Abre un cuadro de diálogo de entrada en el editor del usuario con el mensaje dado y un botón "Aceptar". Este método suspende la secuencia de comandos del servidor mientras el diálogo está abierto. La secuencia de comandos se reanuda después de que el usuario descarta el diálogo, pero las conexiones Jdbc y los bloqueos LockService no persisten durante la suspensión. Para obtener más información, consulta la guía de diálogos y barras laterales.

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

Parámetros

Volver

PromptResponse: Es una representación de la respuesta del usuario.

Abre un cuadro de diálogo de entrada en el editor del usuario con el mensaje y el conjunto de botones especificados. Este método suspende la secuencia de comandos del servidor mientras el diálogo está abierto. La secuencia de comandos se reanuda después de que el usuario descarta el diálogo, pero las conexiones Jdbc y los bloqueos LockService no persisten durante la suspensión. Para obtener más información, consulta la guía de diálogos y barras laterales.

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

Parámetros

Volver

PromptResponse: Es una representación de la respuesta del usuario.

Abre un cuadro de diálogo de entrada en el editor del usuario con el título, el mensaje y el conjunto de botones especificados. Este método suspende la secuencia de comandos del servidor mientras está abierto el diálogo. La secuencia de comandos se reanuda después de que el usuario descarta el diálogo, pero las conexiones Jdbc y los bloqueos LockService no persisten durante la suspensión. Para obtener más información, consulta la guía de diálogos y barras laterales.

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

Parámetros

Volver

PromptResponse: Es una representación de la respuesta del usuario.

Abre un cuadro de diálogo modal en el editor del usuario con contenido personalizado del cliente. Este método no suspende la secuencia de comandos del servidor mientras está abierto el diálogo. Para comunicarse con la secuencia de comandos del servidor, el componente del cliente debe realizar devoluciones de llamada asíncronas con la API de google.script para HtmlService. Para cerrar el diálogo de manera programática, llama a google.script.host.close() en el lado del cliente de una app web HtmlService. Para obtener más información, consulta la guía de diálogos y barras laterales.

Los diálogos modales evitan que el usuario interactúe con otro elemento que no sea el diálogo. Por el contrario, los diálogos sin modo y las barras laterales permiten al usuario interactuar con el editor. En casi todos los casos, un diálogo modal o una barra lateral es una mejor opción que un diálogo sin modo.

// 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');

Parámetros

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Abre un cuadro de diálogo sin modo en el editor del usuario con contenido personalizado del cliente. Este método no suspende la secuencia de comandos del servidor mientras el diálogo está abierto. Para comunicarse con la secuencia de comandos del servidor, el componente del cliente debe realizar devoluciones de llamada asíncronas con la API de google.script para HtmlService. Para cerrar el diálogo de manera programática, llama a google.script.host.close() en el lado del cliente de una app web HtmlService. Para obtener más información, consulta la guía de diálogos y barras laterales.

Los diálogos sin modo permiten al usuario interactuar con el editor detrás del diálogo. Por el contrario, los diálogos modales no lo hacen. En casi todos los casos, un diálogo modal o una barra lateral es una mejor opción que un diálogo sin modo.

// 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');

Parámetros

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

Abre una barra lateral en el editor del usuario con contenido personalizado del cliente. Este método no suspende la secuencia de comandos del servidor mientras la barra lateral está abierta. Para comunicarse con la secuencia de comandos del servidor, el componente del cliente debe realizar devoluciones de llamada asíncronas con la API de google.script para HtmlService. Para cerrar la barra lateral de manera programática, llama a google.script.host.close() en el lado del cliente de una app web HtmlService. Para obtener más información, consulta la guía de diálogos y barras laterales.

La barra lateral se muestra en el lado derecho del editor para los usuarios cuyos entornos usan un idioma de izquierda a derecha y en el lado izquierdo del editor para los idiomas que se leen de derecha a izquierda. Todas las barras laterales que muestran las secuencias de comandos tienen 300 píxeles de ancho.

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

Parámetros

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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