מחלקה של google.script.host (ממשק API בצד הלקוח)

google.script.host הוא ממשק API אסינכרוני של JavaScript בצד הלקוח שיכול לקיים אינטראקציה עם תיבות דו-שיח או סרגלי צד ב-Google Docs, ב-Sheets או ב-Forms שמכילים דפי שירות HTML. כדי להפעיל פונקציות בצד השרת מ: קוד בצד הלקוח, משתמשים ב-google.script.run. מידע נוסף זמין במאמר הבא: ה מדריך לתקשורת עם פונקציות שרת בשירות HTML.

מאפיינים

נכסתיאור
originמספק את הדומיין המארח, כך שסקריפטים יכולים להגדיר את המקור בצורה נכונה.

שיטות

שיטהסוג הערך המוחזרתיאור קצר
close() void סגירת תיבת הדו-שיח או סרגל הצד הנוכחיים.
editor.focus() void משנה את המיקוד של הדפדפן מתיבת הדו-שיח או סרגל הצד לעורך של Google Docs, Sheets או Forms.
setHeight(height) void מגדיר את הגובה של תיבת הדו-שיח הנוכחית.
setWidth(width) void מגדיר את הרוחב של תיבת הדו-שיח הנוכחית.

מסמכי תיעוד מפורטים

close()

סגירת תיבת הדו-שיח או סרגל הצד הנוכחיים.

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

משנה את המיקוד של הדפדפן מתיבת הדו-שיח או סרגל הצד לעורך של Google Docs, Sheets או 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)

מגדיר את הגובה של תיבת הדו-שיח הנוכחית.

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

פרמטרים

שםסוגתיאור
heightIntegerהגובה החדש, בפיקסלים

setWidth(width)

מגדיר את הרוחב של תיבת הדו-שיח הנוכחית.

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

פרמטרים

שםסוגתיאור
widthIntegerהרוחב החדש, בפיקסלים