Klasse google.script.host (Clientseitige API)

google.script.host ist eine asynchrone clientseitige JavaScript API, die mit Dialogfeldern oder Seitenleisten in Google Docs, Google Tabellen oder Google Formulare interagieren kann, die HTML-Dienstseiten enthalten. Verwenden Sie google.script.run, um serverseitige Funktionen aus clientseitigem Code auszuführen. Weitere Informationen findest du im Leitfaden zur Kommunikation mit Serverfunktionen im HTML-Dienst.

Attribute

PropertyBeschreibung
originGibt die Hostdomain an, damit Skripts ihren Ursprung korrekt festlegen können.

Methoden

MethodeRückgabetypKurzbeschreibung
close() void Schließt das aktuelle Dialogfeld oder die aktuelle Seitenleiste.
editor.focus() void Verschiebt den Browserfokus vom Dialogfeld oder der Seitenleiste auf den Google Docs-, Google Tabellen- oder Google Formulare-Editor.
setHeight(height) void Höhe des aktuellen Dialogfelds festlegen
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()

Verschiebt den Browserfokus vom Dialogfeld oder der Seitenleiste auf den Google Docs-, Google Tabellen- oder Google Formulare-Editor.

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)

Höhe des aktuellen Dialogfelds festlegen

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