Classe google.script.host (API côté client)

google.script.host est une API JavaScript côté client asynchrone qui peut interagir à l'aide de boîtes de dialogue ou de barres latérales dans Google Docs, Sheets ou Forms qui contiennent Pages de services HTML : Pour exécuter des fonctions côté serveur à partir de code côté client, utilisez google.script.run. Pour en savoir plus, consultez la guide de communication avec les fonctions de serveur dans le service HTML.

Propriétés

ValeurDescription
originFournit le domaine de l'hôte afin que les scripts puissent définir leur correctement l'origine.

Méthodes

MéthodeType renvoyéBrève description
close() void Ferme la boîte de dialogue ou la barre latérale active.
editor.focus() void Fait passer le curseur du navigateur de la boîte de dialogue ou de la barre latérale à l'éditeur Google Docs, Sheets ou Forms.
setHeight(height) void Définit la hauteur de la boîte de dialogue actuelle.
setWidth(width) void Définit la largeur de la boîte de dialogue actuelle.

Documentation détaillée

close()

Ferme la boîte de dialogue ou la barre latérale active.

Code.gs

function onOpen(e) {
  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
      .createMenu('Sidebar').addItem('Show', 'showSidebar').addToUi();
}

function showSidebar() {
  var html = HtmlService.createHtmlOutputFromFile('Index');
  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
      .showSidebar(html);
}

Index.html

<input type="button" value="Close"
  onclick="google.script.host.close()" />

editor.focus()

Fait passer le curseur du navigateur de la boîte de dialogue ou de la barre latérale à l'éditeur Google Docs, Sheets ou Forms.

Code.gs

function onOpen(e) {
  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
      .createMenu('Sidebar').addItem('Show', 'showSidebar').addToUi();
}

function showSidebar() {
  var html = HtmlService.createHtmlOutputFromFile('Index');
  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
      .showSidebar(html);
}

Index.html

<input type="button" value="Switch focus"
  onclick="google.script.host.editor.focus()" />

setHeight(height)

Définit la hauteur de la boîte de dialogue actuelle.

Code.gs

function onOpen(e) {
  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
      .createMenu('Dialog').addItem('Show', 'showDialog').addToUi();
}

function showDialog() {
  var html = HtmlService.createHtmlOutputFromFile('Index')
      .setWidth(300)
      .setHeight(200);
  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
      .showModalDialog(html, 'Dialog title');
}

Index.html

<script>
  function resizeDialog(width, height) {
    google.script.host.setWidth(width);
    google.script.host.setHeight(height);
  }
</script>
<input type="button" value="Resize dialog"
  onclick="resizeDialog(450, 300)" />

Paramètres

NomTypeDescription
heightIntegerla nouvelle hauteur, en pixels

setWidth(width)

Définit la largeur de la boîte de dialogue actuelle.

Code.gs

function onOpen(e) {
  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
      .createMenu('Dialog').addItem('Show', 'showDialog').addToUi();
}

function showDialog() {
  var html = HtmlService.createHtmlOutputFromFile('Index')
      .setWidth(300)
      .setHeight(200);
  SpreadsheetApp.getUi() // Or DocumentApp or FormApp.
      .showModalDialog(html, 'Dialog title');
}

Index.html

<script>
  function resizeDialog(width, height) {
    google.script.host.setWidth(width);
    google.script.host.setHeight(height);
  }
</script>
<input type="button" value="Resize dialog"
  onclick="resizeDialog(450, 300)" />

Paramètres

NomTypeDescription
widthIntegerla nouvelle largeur, en pixels.