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

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

Propriétés

PropriétéDescription
originFournit le domaine hôte, ce qui permet aux scripts de définir correctement leur origine.

Méthodes

MéthodeType renvoyéBrève description
close() void Ferme la boîte de dialogue ou la barre latérale actuelle.
editor.focus() void Permet de passer du curseur 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 actuelle.

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

Permet de passer du curseur 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
widthIntegernouvelle largeur, en pixels