Klasse google.script.host (Clientseitige API)

google.script.host ist eine asynchrone clientseitige JavaScript API, die interagieren kann mit Dialogfeldern oder Seitenleisten in Google Docs, Google Tabellen oder Google Formulare, die Folgendes enthalten: Seiten des HTML-Dienstes. Um serverseitige Funktionen auszuführen, clientseitigen Code mit google.script.run. Weitere Informationen finden Sie unter die Leitfaden zur Kommunikation mit Serverfunktionen im HTML-Dienst.

Attribute

AttributBeschreibung
originStellt die Hostdomain bereit, sodass Skripts ihre Ursprung korrekt.

Methoden

MethodeRückgabetypKurzbeschreibung
close() void Schließt das aktuelle Dialogfeld oder die aktuelle Seitenleiste.
editor.focus() void Der Fokus des Browsers wird vom Dialogfeld oder der Seitenleiste auf den Google Docs-, Google Tabellen- oder Google Formulare-Editor verlagert.
setHeight(height) void Legt die Höhe des aktuellen Dialogfelds fest.
setWidth(width) void Legt die Breite des aktuellen Dialogfelds fest.

Detaillierte Dokumentation

close()

Schließt das aktuelle Dialogfeld oder die aktuelle Seitenleiste.

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

Der Fokus des Browsers wird vom Dialogfeld oder der Seitenleiste auf den Google Docs-, Google Tabellen- oder Google Formulare-Editor verlagert.

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)

Legt die Höhe des aktuellen Dialogfelds fest.

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

Parameter

NameTypBeschreibung
heightIntegerdie neue Höhe in Pixeln

setWidth(width)

Legt die Breite des aktuellen Dialogfelds fest.

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

Parameter

NameTypBeschreibung
widthIntegerdie neue Breite in Pixeln